ARSetImageToXML

Description

This function saves information about an image to an XML document.

Synopsis

#include "arextern.h"

int ARSetSchemaToXML(
  ARControlStruct *control,
  ARXMLOutputDoc *xmlOutputDoc,
  ARBoolean xmlDocHdrFtrFlag,
  ARNameType imageName,
  char *imageType,
  char *description
  ARAccessNameType owner,
  ARAccessNameType lastModifiedBy,
  char *helpText,
  char *changeHistory,
  ARPropList *objPropList,
  char checksum,
  ARTimestamp *modifiedDate,
  ARImageDataStruct 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.

xmlOutputDoc

The XML document output source.

xmlDocHdrFtrFlag

The header and footer flag for the XML document output source. If there is only one object in the XML document, set this value to 0.

imageName

The image name. Each image name must be unique.

imageType

The image type.

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.

checksum

The checksum of the image content.

modifiedDate

The date that the image was last modified.

imageContent

The image content.

Return values

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.