User Manual

A-10 EK-5209-5 Evaluation Kit User’s Guide
Functions
1. ibApi_Open
ibApi_FUNC ibApi_Open(
ibApi_VERSION expected_version,
ibApi_CONST ibApi_CHAR * server_type,
ibApi_CONST ibApi_CHAR * connection_str
);
ibApi_Open() should be called to initialize the API before any other function is called. The
“server_type” parameter specifies the type of connection, and connection_str contains
various connection parameters that vary according to server type.
Notes: 1. For the current release, the server_type should always be “local”, and the
connection string should be "".
2. These text strings are case-sensitive.
Parameters:
expected_version: (input) Should always be ibApi_EXPECTED_VERSION.
server_type: (input) Should always be “local”, reserved for future use.
connection_str: (input) "", reserved for future use.
Return Value:
An ibApi_APIHANDLE value if successful, error code (<0) if not.
2. ibApi_Close
ibApi_FUNC ibApi_Close(
ibApi_APIHANDLE api_hdl
This disconnects from the server and releases the API resources. This should be called before
your application exits to avoid resource leaks.
Parameter:
api_hdl: (input) API handle returned from ibApi_Open()
Return Value:
An ibApi_RESULT_SUCCESS if successful, error code (<0) if not.
3. ibApi_GetApiVersion()
ibApi_FUNC ibApi_GetApiVersion ();