ARExportToFile

Important

You can continue to use C APIs to customize your application, but C APIs are not enhanced to support new capabilities provided by Java APIs and REST APIs.

Description

Exports the indicated structure definitions from the specified server to a file. Use this function to copy structure definitions from one AR System server to another.

Important

Form exports do not work the same way with ARExportToFile as they do in Developer Studio. Other than views, you cannot automatically export related items along with a form. You must explicitly specify the workflow items that you want to export. Also, ARExportToFile cannot export a form without embedding the server name in the export file (something you can do with the Server-Independent option in Developer Studio).

Related topics

ARExport

ARImport

FreeAR 

Privileges

For filters, escalations, character menus, and distributed mappings, this operation can be performed only by users with AR System administrator privileges. For forms, containers, and active links, this operation can be performed by users with access permission for the specified structure. Access to groupList information for these structures is limited to users with AR System administrator privileges.

Synopsis

#include "ar.h"
#include "arerrno.h"
#include "arextern.h"
#include "arstruct.h"

int ARExportToFile(
  ARControlStruct *control,
  ARStructItemList *structItems,
  ARNameType displayTag,
  unsigned int vuiType,
  ARWorkflowLockStruct *lockinfo,
  FILE *filePtr,
  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 and server fields are required.

structItems

A list of zero or more structure items to export (identified by type and name). See Importing-and-exporting-and-structures.

displayTag

The label of the form view (VUI) to export. You must specify this parameter to export a particular view (AR_STRUCT_ITEM_SCHEMA_VIEW). If the specified view does not exist (or you specify NULL for this value), the system exports the default view. The system exports the first view in the list if the form does not have a default view.

vuiType

The type of VUI to export.

lockInfo

To export objects as locked, you must supply this parameter. If exporting in unlocked mode, you can set this to NULL.

Important

The locking feature is for protecting your intellectual property. You can now export workflow as locked (either read-only lock or hidden-lock) and deliver it to your customers. When your customer imports the workflow, the system seamlessly runs that workflow but restricts the clients from getting the definition data, thus preventing human administrators or API clients from viewing or modifying the definition.

The values consist of a lock type and lock key. Valid values for the lock type are:

Lock key is a string that is to be used as a key (or a password) to enforce the locking.

filePtr

A pointer to the export file to be created in the system.

Return values

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.

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*