ARGetMultipleCharMenus
Privileges
All users.
Synopsis
#include "arerrno.h"
#include "arextern.h"
#include "arstruct.h"
int ARGetMultipleCharMenus(
ARControlStruct *control,
ARTimestamp changedSince,
ARNameList *nameList,
ARBooleanList *existList,
ARNameList *charMenuNameList,
ARUnsignedIntList *refreshCodeList,
ARCharMenuStructList *menuDefnList,
ARTextStringList *helpTextList,
ARTimestampList *timestampList,
ARAccessNameList *ownerList,
ARAccessNameList *lastChangedList,
ARTextStringList *changeDiaryList,
ARPropListList *objPropListList,
ARStatusList *status)
Input arguments
control
The control record for the operation. It contains information about the user requesting the operation, where that operation is to be performed, and which session is used to perform it. The user and server fields are required.
To specify whether to search for an object's real or resolved name, use the AR_SESS_CONTROL_PROP_API_OVERLAYGROUP variable of the ARSetSessionConfiguration function (see ARSetSessionConfiguration). For calls that use field or view IDs, the search is performed on the real or resolved name of the associated form.
If you do not use the AR_SESS_CONTROL_PROP_API_OVERLAYGROUP variable, the AR System server uses the default overlay group at run time. For information about configuring the default overlay group, see the description for Overlay-mode in Configuration-settings-N-R.
changedSince
A time stamp that limits the character menus retrieved to those modified after the specified time. Specify 0 for this parameter to retrieve character menus with any modification time stamp.
nameList
The names of the character menus to be retrieved. The nameList can be passed as a NULL or as an empty list, as in:
...
ARGetMultipleCharMenus(control, changedSince, &emptyNameList, ...)
In this case information is returned for every character menu that passes the changedSince criterion.
Return values
existList
A list of flags and corresponding Boolean values that indicate whether the character menus exist. The value TRUE means the character menu exists and FALSE means the character menu does not exist.
charMenuNameList
A list of character menu names to be retrieved.
refreshCodeList
A value that indicates when the list of character menus is refreshed. See ARCreateCharMenu for a description of the possible values.
Specify NULL for this parameter if you do not want to retrieve this value.
menuDefnList
A list of definitions of character menus.
Specify NULL for this parameter if you do not want to retrieve this value.
helpTextList
A list of help text items associated with the character menus.
Specify NULL for this parameter if you do not want to retrieve the help text (which is useful if you are calling this function to verify whether an instance of these objects exists).
timeStampList
A list of time stamps that specify the last change to the character menus.
Specify NULL for this parameter if you do not want to retrieve this value.
ownerList
A list of owning users for the character menus.
Specify NULL for this parameter if you do not want to retrieve this value.
lastChangedList
A list of users who made the last change to the character menus.
Specify NULL for this parameter if you do not want to retrieve this value.
changeDiaryList
A list of change diaries associated with the character menus.
Use ARDecodeDiary to parse the change diary into user, time stamp, and text components. The server adds the user making the change and a time stamp when it saves the change diary.
Specify NULL for this parameter if you do not want to retrieve the change diary list. This value can be large, so do not retrieve it if the program does not need it; for example, if the program is only checking if an object exists.
objPropListList
A list of server object property lists that correspond to the menus in nameList*.* If you set this parameter to NULL, no properties are returned. See Server-object-properties-and-structures.
status
A list of zero or more notes, warnings, or errors generated from a call to this function. For a description of all possible values, see Error-checking.