ARDecodeARAssignStruct

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 a serialized assign string in a DEF file into an ARAssignStruct structure to facilitate string import.

Privileges

All users.

Synopsis

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

int ARDecodeARAssignStruct(
  ARControlStruct *control,
  char *assignText,
  ARAssignStruct *assignStruct,
  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.

assignText

The serialized assign string to be converted.

Return values

assignStruct

The resulting ARAssignStruct 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.