ARSetSchemaWithExtendedFieldsToXML
Privileges
All users.
Synopsis
int ARSetSchemaWithExtendedFieldsToXML(
ARControlStruct *control,
ARXMLOutputDoc *xmlOutputDoc,
ARBoolean xmlDocHdrFtrFlag,
ARNameType schemaName,
ARCompoundSchema *compoundSchema,
ARPermissionList *permissionList,
ARInternalIdList *subAdminGrpList,
AREntryListFieldList *getListFields,
ARSortList *sortList,
ARIndexList *indexList,
ARArchiveInfoStruct *archiveInfo,
ARAuditInfoStruct *auditInfo,
ARNameType defaultVUI,
ARInternalId *nextFieldID,
ARULong32 *coreVersion,
int *upgradeVersion,
ARExportFieldInfoList *fieldInfoList,
ARVuiInfoList *vuiInfoList,
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.
schemaName
The schema name. Each schema name must be unique.
compoundSchema
The definition of the candidate form or table that contains the candidate field to be retrieved.
permissionList
A list of zero or more groups who can access the form. Access to this information is limited to users with administrator privileges only.
Specify NULL for this parameter if you do not want to retrieve the group list.
subAdminGrpList
A list of zero or more groups who can administer this form (and the associated filters, escalations, and active links). Users must belong to both a specified group and the Subadministrator group to obtain these privileges.
Specify NULL for this parameter if you do not want to retrieve the administrator group list.
getListField
A list of zero or more fields that identify the default query list data for retrieving form entries.
Specify NULL for this parameter if you do not want to retrieve this value.
sortList
A list of zero or more fields that identify the default sort order for retrieving form entries.
Specify NULL for this parameter if you do not want to retrieve the default sort fields.
indexList
The set of zero or more indexes for the form.
Specify NULL for this parameter if you do not want to retrieve the index list.
archiveInfo
If you want to archive the form, this is the archive information for the form.
Specify NULL for this parameter if you do not want to create or set the archive information. The archive type options are:
In addition to the archive type, archiveInfo also stores the form name (if archive type is AR_ARCHIVE_FORM), time to trigger the archive, archive qualification criteria, and name of the main form that is being archived.
auditInfo
If you want to audit the form, this is the audit information for the form.
Specify NULL for this parameter if you do not want to create or set the audit information. These are the values for audit type:
In addition to the audit type, auditInfo also stores the form name (if audit type is AR_AUDIT_COPY or AR_AUDIT_LOG) and the audit qualification criteria.
defaultVui
The label for the default view.
nextFieldID
The next default field identification number, which the server generates if users do not specify it.
coreVersion
The version number of the core fields.
upgradeVersion
The upgrade version for auto generated internal server schemas. To disable this option, set it to zero 0.
fieldInfoList
The list of schema fields.
vuiInfoList
The list of schema views.
owner
The schema owner.
lastModifiedBy
The user who last modified the schema.
modifiedDate
The date that the schema was last modified.
helpText
The help text associated with the schema.
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 schema.
objPropList
The object properties of the schema.
arDocVersion
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.