ARGetDSOPoolFromXML

Description

Retrieves information about a DSO pool from a definition in an XML document.

Privileges

All users.

Synopsis

#include "arextern.h"

int ARGetDSOPoolFromXML(
ARControlStruct *control,
  ARXMLParsedStream *parsedStream,
  ARNameType poolName,
  ARNameType appBlockName,
  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 is to be performed, and which session is used to perform it. The user, sessionId, and server fields are required.

parsedStream

The parsed XML stream.

poolName

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

appBlockName

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

Return values

enabled

A flag that specifies whether the DSO pool is disabled (0) or enabled (1). Specify NULL for this parameter if you do not want to retrieve this value.

defaultPool

A value that indicates that this is the default pool.

threadcount

The thread count of the DSO pool.

connection

This parameter is reserved for future use.

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

lastModifiedBy

The user who last modified the DSO pool.

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 XML document version.

status

A list of zero or more notes, warnings, or errors generated from a call to this function. For a description of all possible values, see Error-checking.