ARSetDSOPoolToXML

Description

This function saves information about a Distributed Server Option (DSO) pool in an XML document.

For more information about DSO mapping, see Creating-distributed-mappings.

Synopsis

#include "arextern.h"

int ARSetDSOPoolToXML(
  ARControlStruct *control,
  ARXMLOutputDoc *xmlOutputDoc,
  ARBoolean xmlDocHdrFtrFlag,
  ARNameType poolName,
  unsigned int *enabled,
  unsigned int *defaultPool,
  long *threadCount,
  char **connection,
  unsigned int *polling,
  unsigned int *pollingInterval,
  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 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.

poolName

The name of the DSO pool. Each pool name must be unique.

enabled

A flag that specifies whether the DSOpool is disabled (0) or enabled (1).

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

defaultPool

The code that indicates whether there is a default pool.

threadcount

The thread count of the DSO pool.

polling

Indicates whether this pool polls the pending queue for pending items assigned to it. Pools are signaled by default.

pollingInterval

The polling interval (if the pool is a polling pool).

owner

The owner for the DSO pool.

lastModifiedBy

The user who last modified the DSOpool.

modifiedDate

The date that the DSO pool was last modified.

helpText

The help text associated with the DSO pool.

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 DSO pool.

objPropList

The properties of the DSO pool.

arDocVersion

The version of the XML document.

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.