ARGetMultipleCharMenus

Note

You can continue to use C APIs to customize your application, but C APIs are not enhanced to support new capabilities provided by Java APIs and REST APIs.

Description

Retrieves from the specified server information about the character menus whose names are specified by the nameList parameter. This function performs the same action as ARGetCharMenu but is easier to use and more efficient than retrieving information about multiple character menus one by one. Information is returned in lists for each item, with one item in the list for each menu returned. For example, if the second item in the list for existList is TRUE, the name of the second character menu is returned in the second item in the list for charMenuNameList.

Privileges

All users.

Synopsis

#include "ar.h"
#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 BMC Remedy 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 retrieve. The nameList can be passed as a NULL or as an empty list, as in:

ARNameList emptyNameList = {0, 0};
...
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. Values: TRUE means the character menu exists; FALSE means the character menu does not exist.

charMenuNameList

A list of character menu names 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 it an object exists.

objPropListList

A list of server object property lists that correspond to the menus in nameList*.* If this parameter is set to NULL, no properties are returned. See Server object properties.

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.