ARParseXMLDocument

Description

Parses the contents of an XML document.

Synopsis

#include "arextern.h"

int ARParseXMLDocument(
  ARControlStruct *control,
  ARXMLInputDoc *xmlnputDoc,
  ARStructItemList *objectsToParse,
  ARXMLParsedStream *parsedStream,
  ARStructItemList *parsedObjects,
  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.

xmlInputDoc

The XML document to be parsed.

objectsToParse

The specific list of objects to parse.

Specify NULL if you do not want to parse any objects.

Return values

parsedStream

The parsed XML stream.

parsedObjects

The list of parsed objects.

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.