ARGetActiveLinkFromXML

Description

Retrieves information about an active link from a definition in an XML document.

Privileges

All users.

Synopsis

#include "arextern.h"

int ARGetActiveLinkFromXML(
  ARControlStruct *control,
  ARXMLParsedStream *parsedStream,
  ARNameType activeLinkName,
  ARNameType appBlockName,
  unsigned int *executionOrder,
  ARWorkflowConnectStruct *workflowConnect,
  ARInternalIdList *accessList,
  unsigned int *executeOn,
  ARInternalId *controlFieldID,
  ARInternalId *focusFieldID,
  unsigned int *enabled,
  ARQualifierStruct *query,
  ARActiveLinkActionList *ifActionList,
  ARActiveLinkActionList *elseActionList,
  ARSupportFileInfoList *supportFileList,
  ARAccessNameType owner,
  ARAccessNameType lastModifiedBy,
  ARTimestamp *modifiedDate,
  char **helpText,
  char **changeHistory,
  ARPropList *objPropList,
  unsigned int *arDocVersion,
  unsigned int *errorActlinkOptions,
  ARNameType errorActlinkName,
  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, sessionId, and server fields are required.

parsedStream

The parsed XML stream.

activeLinkName

The active link name. Each active link name must be unique.

appBlockName

For deployable applications, the application block name of the active link.

Return values

executionOrder

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.

workflowConnect

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 this value.

accessList

A list of lists containing zero or more groups who can access the fields retrieved. Access to this information is limited to users with administrator privileges only. Specify NULL for this parameter if you do not want to retrieve the permissions.

executeOn

A bitmask that indicates the form operations that trigger the active link. Specify NULL for this parameter if you do not want to retrieve this value.

controlFieldID

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.

focusFieldID

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.

enabled

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.

ifActionList

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.

elseActionList

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.

supportFileList

The support file that the active link uses.

owner

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

lastModifiedBy

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

modifiedDate

The date that the active link was last modified.

helpText

The help text associated with the active link. 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 this object exists).

changeHistory

The change history of the active link.

objPropList

The object properties of the active link.

arDocVersion

The XML document version.

errorActlinkOptions

Reserved for future use. Set to NULL.

errorActlinkName