ARGetContainerFromXML

Description

Retrieves information about a container from a definition in an XML document.

Privileges

All users.

Synopsis

#include "arextern.h"

int ARGetContainerFromXML(
  ARControlStruct *control,
  ARXMLParsedStream *parsedStream,
  ARNameType containerName,
  ARNameType appBlockName,
  ARPermissionList *permissionList,
  ARInternalIdList *subAdminGrpList,
  ARContainerOwnerObjList *ownerObjectList,
  char **label,
  char **description,
  unsigned int *containerType,
  ARReferenceList *referenceList,
  ARAccessNameType owner,
  ARAccessNameType lastModifiedBy,
  ARTimestamp *modifiedDate,
  char **helpText,
  char **changeHistory,
  ARPropList *objPropList,
  unsigned int *arDocVersion,
  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.

containerName

The container name. Each container name must be unique.

appBlockName

For a deployable application, this is the application block name of the container.

Return values

permissionList

A list of zero or more groups who can access this container. Access to this information is limited to users with AR System administrator privileges only. Specify NULL for this parameter if you do not want to retrieve this value.

subAdminGrpList

The list of groups that have access to the container.

ownerObjectList

A list of schemas that own this container. This parameter can be NULL if the container exists globally.

label

The label for this container. It can be as many as 255 characters long or NULL.

description

The description for this container. It can be as many as 2000 characters long or NULL.

containerType

The type for this container — either guide (ARCON_GUIDE), application (ARCON_APP), or a custom type you have defined.

referenceList

A list of pointers to the objects referenced by this container. References can be to internal AR System objects (for example, guides reference active links and applications reference forms) or to external objects such as URLs or file names. Specify NULL for this parameter if you do not want to associate any objects with this container.

owner

The container owner.

lastModifiedBy

The user who last modified the container.

modifiedDate

The date that the container was last modified.

helpText

The help text associated with the container. 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 container.

objPropList

The object properties of the container.

arDocVersion

The XML document version.

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.