ARGetListXMLObjects

Description

This function retrieves object names and types from an XML document.

Synopsis

#include "arextern.h"

int ARGetListXMLObjects(
  ARControlStruct *control,
  ARXMLInputDoc *xmlInputDoc,
  ARUnsignedIntList *objectTypeList,
  ARNameList *objectNameList,
  ARUnsignedIntList *subTypeList,
  ARNameList* *appBlockNameList,
  ARStatusList *status)

Input arguments

control

The control record for the operation. It contains information about the user requesting the operation, where that operation must be performed, and the session used to perform it. The user, sessionId, and server fields are required.

xmlDocSource

The XML document output source.

Return values

objectTypeList

A list of the object types.

objectNameList

A list of the object names.

subTypeList

The object subtypes.

appBlockNameList

For a deployable application, this is the list of application block names for the object. The array indexes of the application block name list corresponds to the array index of the parsedObjects lists.

Specify NULL for this parameter if you do not want to retrieve it.

status

A list of zero or more notes, warnings, or errors generated from a call made to this function.

For a description of all possible values, see Error-checking.