ARGetCharMenu

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 information about the character menu with the indicated name from the specified server.

Privileges

All users.

Synopsis

#include "ar.h"
#include "arerrno.h"
#include "arextern.h"
#include "arstruct.h"

int ARGetCharMenu(
  ARControlStruct *control,
  ARNameType name,
  unsigned int *refreshCode,
  ARCharMenuStruct *menuDefn,
  char **helpText,
  ARTimestamp *timestamp,
  ARAccessNameType owner,
  ARAccessNameType lastChanged,
  char **changeDiary,
  ARPropList *objPropList,
  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 description for Overlay-mode in ar-cfg-or-ar-conf-options-N-R.

name

The name of the character menu to retrieve.

Return values

refreshCode

A value that indicates when the menu 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.

menuDefn

The definition of the character menu. Specify NULL for this parameter if you do not want to retrieve this value.

helpText

The help text associated with the character menu. Specify NULL for this parameter if you do not want to retrieve the help text. 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.

timestamp

A time stamp that specifies the last change to the character menu. Specify NULL for this parameter if you do not want to retrieve this value.

owner

The owning user for the character menu. Specify NULL for this parameter if you do not want to retrieve this value.

lastChanged

The user who made the last change to the character menu. Specify NULL for this parameter if you do not want to retrieve this value.

changeDiary

The change diary associated with the character menu. 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. 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.

objPropList

A list of server object properties. If this parameter is set to NULL, a properties list with zero properties is associated with the object, and when an ARGetCharMenu action is performed, zero 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.