General functions, Shinitialize, Shfinalize – Bird Technologies SignalHawk User Manual

Page 16: Sherrordata structure members, Arguments returns

Advertising
background image

Bird Technologies

4

shErrorData Structure Members

General Functions

shInitialize

This function initializes the API. This must be called before any other

API function.

DWORD shInitialize()

Arguments

None.

Returns

Returns an error code indicating the status of the operation:

shFinalize

This function releases resources used by the API.

DWORD shFinalize()

Arguments

None.

Returns

Returns an error code indicating the status of the operation:

ErrorCode Numeric

code for the error.

ErrorMessage[MAX_ERROR_ME
S_SIZE]

Short message of type TCHAR,
describing the error.

ERROR_SUCCESS

Initialization was successful.

SH_ERROR_INITIALIZE_USB_
LIBRARY_FAILED

The USB driver library failed to load.

Others Call

shGetLastError() for information on

the specific error.

ERROR_SUCCESS

Finalize was successful.

SH_ERROR_FINALIZE_FAILED

There was an error while cleaning up
the USB library.

Other Call

shGetLastError() for information on

the specific error.

Advertising