ARGetActiveLink

Description

Retrieves information about the active link with the indicated name from the specified server.

Privileges

This operation can be performed by users with access permission for the active link. Access to groupList information is limited to users with BMC Remedy AR System administrator privileges.

Synopsis

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.

name

The name of the active link to retrieve.

Return values

order

A value between 0 and 1000(inclusive) that determines the active link execution order. When multiple active links are associated with a form, the value associated with each active link determines the order in which they are processed (from lowest to highest). Specify NULL for this parameter if you do not want to retrieve this value.

schemaList

The list of form names the active link is linked to. The active link must be associated with a single form or a list of forms that currently exists on the server. Specify NULL for this parameter if you do not want to retrieve the list.

assignedGroupList

A list of zero or more groups that are directly assigned permission to the active link.

groupList

A list of zero or more groups who can access this active link, including the inheritance hierarchy in the case of hierarchical groups. Access to this information is limited to users with BMC Remedy AR System administrator privileges. Specify NULL for this parameter if you do not want to retrieve this value.

If the static inheritance property is not enabled for the active link, this list will be the same as the assignedGroupList.

executeMask

A bitmask that indicates the form operations that trigger the active link. See ARCreateActiveLink for a description of the possible values. Specify NULL for this parameter if you do not want to retrieve this value.

controlField

The ID of the field that represents the button, toolbar button, or menu item associated with executing the active link. The system returns zero if the executeMask does not include the AR_EXECUTE_ON_BUTTON condition. Specify NULL for this parameter if you do not want to retrieve this value.

focusField

The ID of the field associated with executing the active link by pressing Return or selecting a character menu item. The system returns zero if the executeMask does not include the AR_EXECUTE_ON_RETURN or AR_EXECUTE_ON_MENU_CHOICE conditions. Specify NULL for this parameter if you do not want to retrieve this value.

enable

A flag that specifies whether the active link is disabled (0) or enabled (1). Specify NULL for this parameter if you do not want to retrieve this value.

query

A qualification that determines whether the active link is executed. The system returns zero (AR_COND_OP_NONE) if the active link has no qualification. Specify NULL for this parameter if you do not want to retrieve this value.

actionList

The set of actions performed if the condition defined by the query parameter is satisfied. This list can contain from 1 to 25 actions (limited by AR_MAX_ACTIONS). Specify NULL for this parameter if you do not want to retrieve this value.

elseList

The set of actions performed if the condition defined by the query parameter is not satisfied. This list can contain from 0 to 25 actions (limited by AR_MAX_ACTIONS). Specify NULL for this parameter if you do not want to retrieve this value.

helpText

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

owner

The active link owner. Specify NULL for this parameter if you do not want to retrieve this value.

lastChanged

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

changeDiary

The change diary associated with the active link. 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, no properties list is returned. See Server object properties.

errorActlinkOptions

Reserved for future use. Set to NULL.

errorActlinkName

Reserved for future use. Set to NULL.

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.

See also

ARCreateAlertEvent, ARDecodeDiary, ARDeleteActiveLink, ARGetListActiveLink, ARGetMultipleActiveLinks, ARSetActiveLink. See FreeAR for: FreeARActiveLinkActionList, FreeARInternalIdList, FreeARPropList, FreeARQualifierStruct, FreeARStatusList.