AREncodeStatusHistory

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 ARStatusHistoryList into a status history 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 AREncodeStatusHistory(
  ARControlStruct *control,
  ARStatusHistoryList *statHistList,
  char **statHistString,
  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.

statHistList

The ARStatusHistoryList structure to convert.

Return values

statHistString

The resulting status history string.

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.