ARDecodeDiary

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

Parses any diary field (including the changeDiary associated with every AR System object) into user, time stamp, and text components. The function takes the formatted string returned for all diary fields and decodes it into an array of diary entries.

Synopsis

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

int ARDecodeDiary(
  ARControlStruct *control,
  char *diaryString,
  ARDiaryList *diaryList,
  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.

diaryString

A formatted diary string returned by ARGetEntry or any of the ARGet Object API functions.

Return values

diaryList

An array of decoded diary 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.