Skip to Content

Login and session information

Almost every AR System C API function has a control parameter as its first input argument. This parameter contains the login and session information required to connect to an AR System server and, thus, required for almost every operation.

The control parameter is a pointer to an ARControlStruct structure. See the following image:

Related topics

Developing-an-API-program

Data-structures


Structure used to provide required login information 
221_DataStruct_ReqLoginInfo.png

This structure has the following elements:

Nearly all function calls require the login and session information that ARControlStruct contains (stored in both single and multiple-server environments) because the API does not always maintain a server connection between calls.

When a program calls ARInitialization at the beginning of its execution, the AR System C API returns the data in a ARControlStruct. This is the structure that the program passes as an input parameter in subsequent API calls.

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*

BMC Helix Innovation Suite 25.4