AREncodeARAssignStruct

Note

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

Converts an ARAssignStruct structure into a serialized assignment string. The resulting string is stored in a DEF file and is used for exporting definitions of ARServer objects.

Privileges

All users.

Synopsis

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

int (AREncodeARAssignStruct
  ARControlStruct *control,
  ARAssignStruct *assignStruct,
  char **assignText,
  ARStatusList *status)

Input arguments

control

The control record for the operation. It contains information about the user requesting the operation, where that operation is performed, and what session performs it. The user and server fields are required.

assignStruct

The ARAssignStruct structure to convert.

Return values

assignText

A serialized representation of the assignment structure.

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.