ARGetListCharMenu

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 a list of character menu names from the specified server. You can retrieve all character menus or limit the list to character menus modified after a specified time.

Privileges

All users.

Synopsis

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

int ARGetListCharMenu(
  ARControlStruct *control,
  ARTimestamp changedSince,
  ARNameList *formList,
  ARNameList *actLinkList,
  ARPropList *objPropList
  ARNameList *nameList,
  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.

formList

A form name list that limits the character menus retrieved to the ones that are referenced by fields in the form.

actLinkList

An active link list that limits the character menus retrieved to the ones that have a change field action with the character menus.

objPropList

List of server-managed object properties to search for. Returns all character menus that match the object properties, for example, the application owner. See Server-managed object property tags.

Return values

nameList

A list of zero or more character menus that match the criteria defined in the changedSince, formList, actLinkList, and objPropList parameters. The system returns a list with zero items if no character menus match the specified criteria.

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.