ARGetFieldFromXML

Description

Retrieves information about a field from an XML document.

Privileges

All users.

Synopsis

#include "arextern.h"

int ARGetFieldFromXML(
  ARControlStruct *control,
  ARXMLParsedStream *parsedStream,
  ARNameType fieldName,
  ARNameType appBlockName,
  ARInternalId *fieldID,
  ARFieldMappingStruct *fieldMapping,
  unsigned int *dataType,
  unsigned int *entryMode,
  unsigned int *createMode,
  unsigned int *fieldOption
  ARValueStruct *defaultValue,
  ARPermissionList *permissionList,
  ARFieldLimitStruct *fieldLimit,
  ARDisplayInstanceList *dInstanceList,
  ARAccessNameType owner,
  ARAccessNameType lastModifiedBy,
  ARTimestamp *modifiedDate,
  char **helpText,
  char **changeHistory,
  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.

fieldName

The field name. Each field name must be unique.

appBlockName

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

Return values

fieldId

The internal ID of the field to retrieve.

fieldMapping

The underlying form that contains the field (only applicable to join forms). Specify NULL for this parameter if you do not want to retrieve the field mapping.

dataType

The data type of the field. See the ARCreateField information in AR-System-C-API-functions for a description of the possible values. Specify NULL for this parameter if you do not want to retrieve the data type.

entryMode

The entry mode type.

createMode

A flag that indicates the permission status for the field when users submit entries. See ARCreateField information in AR-System-C-API-functions for a description of the possible values. Specify NULL for this parameter if you do not want to retrieve this flag.

fieldOption

A bitmask that indicates whether the field is to be audited or copied when other fields are audited.

defaultValue

The value to apply if a user submits an entry with no field value (only applicable to data fields). The system returns 0 (AR_DEFAULT_VALUE_NONE) if the field has no default. Specify NULL for this parameter if you do not want to retrieve the default value.

permissionList

The list of group access permissions.

fieldLimit

The value limits for the field and other properties specific to the field's type. See Defining field limits for a description of the contained structure that applies to the type of field that you are creating. Specify NULL (or AR_FIELD_LIMIT_NONE) for trim and control fields or if you do not want to retrieve the limits and properties.

dInstanceList

A list of zero or more display properties associated with the field. See ARCreateField for a description of the possible values. The system returns 0 (AR_DPROP_NONE) if the field has no display properties. Specify NULL for this parameter if you do not want to retrieve this list.

owner

The owner for the field.

lastModifiedBy

The user who last modified the field.

modifiedDate

The date that the field was last modified.

helpText

The help text associated with the field. 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 field.

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.