ARGetImageFromXML

Description

This function retrieves information about an image from an XML document.

Synopsis

#include "arextern.h"

int ARGetSchemaFromXML(
  ARControlStruct *control,
  ARXMLParsedStream *parsedStream,
  ARNameType imageName,
  ARNameType appBlockName,
  char **imageType,
  unsigned in *contentLength,
  char **checksum,
  ARTimestamp *timestamp,
  char **description,
  ARAccessNameType owner,
  ARAccessNameType lastModifiedBy,
  char **helpText,
  char **changeHistory,
  ARPropList *objPropList,
  char **imageContent,
  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.

parsedStream

The parsed XML stream.

imageName

The image name. Each schema name must be unique.

appBlockName

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

Return values

imageType

The type of the image.

contentLength

The size of the image.

checksum

The checksum of image content.

timestamp

The date that the image was last modified.

description

The image description.

owner

The image owner.

lastModifiedBy

The user who last modified the image.

helpText

The help text associated with the image.

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 image.

objPropList

The object properties of the image.

imageContent

The image content.

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.