ARGetDSOMappingFromXML

Description

This function retrieves information about a Distributed Server Option (DSO) mapping from a definition in an XML document.

For more information about DSOmapping, see Creating-distributed-mappings.

Synopsis

#include "arextern.h"

int ARGetDSOMappingFromXML(
  ARControlStruct *control,
  ARXMLParsedStream *parsedStream,
  ARNameType mappingName,
  ARNameType appBlockName,
  ARNameType fromSchema,
  ARServerNameType fromServer,
  ARNameType toSchema,
  ARServerNameType toServer,
  unsigned int *enabled,
  unsigned int updateCode,
  unsigned int *transferMode,
  unsigned int *mapType,
  unsigned int *rtnMapType,
  unsigned int *defaultMap,
  unsigned int *duplicateAction,
  unsigned int *patternMatch,
  unsigned int *requiredFields,
  long *retryTime,
  char **mapping,
  char **rtnMapping,
  char **matchQual,
  char **excludeFlds
  char **rtnExcludeFlds
  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.

parsedStream

The parsed XML stream.

mappingName

The name of the schema to be exported. Each schema name must be unique.

appBlockName

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

Return values

fromSchema

The name of the source schema. Each schema name must be unique.

fromServer

The name of the source server.

toSchema

The name of the target schema.

toServer

The name of the target server.

enabled

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

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

updateCode

A value that indicates when the system is to update the DSO mapping after changing the entry.

transferMode

The transfer mode.

mapType

The type of mapping to use on transfer of data between the servers

rtnMapType

The type of mapping to use on update or return event.

defaultMap

A value that indicates the default mapping.

duplicateAction

The action to perform on transfer of data to existing entry.

patternMatch

A value that indicates that pattern matching is enabled.

requiredFields

A value that indicates if required fields can be ignored.

retryTime

The maximum number of seconds that the server waits to remap the schema, before it cancels the operation.

mapping

A value that indicates custom mapping if the mapType value is custom.

rtnMapping

A value that indicates custom mapping if the rtnMapType value is custom.

matchQual

The matching qualification.

excludeFlds

A value that indicates the fields that must excluded from transfer mapping when the mapType value is Like IDs or Like Names.

The list of field ids are separated by a semi-colon.

rtnExcludeFlds

A value that indicates the fields to that must be excluded from update or return mapping when the rtnMapType value is Like IDs or Like Names. The list of field ids is separated by a semi-colon.

owner

The owner of the DSO mapping.

lastModifiedBy

The user who last modified the DSO mapping.

modifiedDate

The date that the DSOmapping was last modified.

helpText

The help text associated with the DSO mapping.

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

objPropList

The properties of the DSO mapping object.

arDocVersion

The XML document version.

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.