ARInitialization

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

Performs server and network specific initialization operations for each AR Systemsession. All API programs that interact with the AR System must call this function before calling any other AR System API functions. Your program can call this function again to create additional sessions.

Privileges

All users.

Synopsis

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

int ARInitialization(
ARControlStruct *control,
ARStatusList *status)

Input arguments

control

The control record for the operation. The control parameter must be the first input argument. 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. The sessionId field, which you must supply in the control record for most other functions, is returned by this function.

To use Unicode (UTF-8) as the client character set, set the ARControlStruct localInfo.charSet field as follows:

memset(&control, '\0', sizeof(control));
strcpy(control.localeInfo.charSet, "UTF-8");
...
if (ARInitialization(&control, &status) >= AR_RETURN_ERROR)

Pass an empty string as localeInfo.charSet to get the normal API behavior. That is, the client character set is the character set implied by the client's locale.

The other fields of ARControlStruct may be null, and ARInitialization automatically fills them.

Return values

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.