ARGetMultipleEscalations
Privileges
All users.
Synopsis
#include "arerrno.h"
#include "arextern.h"
#include "arstruct.h"
int ARGetMultipleEscalations(
ARControlStruct *control,
ARTimestamp changedSince,
ARNameList *nameList,
ARBooleanList *existList,
ARNameList *esclNameList,
AREscalationTmList *esclTmList,
ARWorkflowConnectList *workflowConnectList,
ARUnsignedIntList *enableList,
ARQualifierList *queryList,
ARFilterActionListList *actionListList,
ARFilterActionListList *elseListList,
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 escalations retrieved to those modified after the specified time.
Specify 0 for this parameter to retrieve escalations with any modification time stamp.
nameList
The names of the escalations to be retrieved. You can pass the nameList as a NULL or as an empty list, as in:
...
ARGetMultipleEscalations(control, changedSince, &emptyNameList, ...)
In this case information is returned for every escalation that passes the changedSince condition.
Return values
existList
A list of flags and corresponding Boolean values that indicate whether the escalations exist. The values TRUE means the escalation exists and FALSE means the escalation does not exist.
esclNameList
A list of zero or more escalations that match the criteria defined in the changedSince and nameList parameters. The system returns a list with zero items if no escalations match the specified criteria.
esclTMList
A list of AREscalationTmStruct. ARGetEscalation returns a single AREscalationTmStruct, which describes when the escalation executes, such as once an hour or on specified days.
workflowConnectList
A list of the items that ARGetEscalation returns one at a time, which are the schemas to which the escalation is attached.
enableList
A list of flags that specify whether the escalation is disabled (0) or enabled (1).
Specify NULL for this parameter if you do not want to retrieve these flags.
queryList
A list of qualifications that determines whether the escalations are executed. The system returns zero (AR_COND_OP_NONE) if the escalations have no qualifications.
Specify NULL for this parameter if you do not want to retrieve the queries.
actionListList
A list of the sets of actions performed if the condition defined by the query parameter is satisfied. This list can contain 1 to 25 actions (limited by AR_MAX_ACTIONS).
Specify NULL for this parameter if you do not want to retrieve the action lists.
elseListList
A list of the sets of actions performed if the conditions defined by the query parameter is not satisfied. This list can contain 0 to 25 actions (limited by AR_MAX_ACTIONS).
Specify NULL for this parameter if you do not want to retrieve the else list.
helpTextList
A list of help text items associated with the escalations.
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 escalations.
Specify NULL for this parameter if you do not want to retrieve this value.
ownerList
A list of owning users for the escalations.
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 escalations.
Specify NULL for this parameter if you do not want to retrieve this value.
changeDiaryList
A list of change diaries associated with the escalations.
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 ifan object exists.
objPropListList
A list of server object property lists that correspond to the escalations 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.