ARDecodeStatusHistory

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

Parses the Status History core field into user and time stamp components. The function takes the formatted string returned for this field and decodes it into an array of status history entries.

Privileges

All users.

Synopsis

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

int ARDecodeStatusHistory(
  ARControlStruct *control,
  char *statHistString,
  ARStatusHistoryList *statHistList,
  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.

statHistString

A formatted status history string returned by ARGetEntry.

Return values

statHistList

An array of decoded status history entries.

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.