beautypg.com

Shconnectdefault, Shgetdevicelist, Arguments returns remarks – Bird Technologies SignalHawk User Manual

Page 17: Arguments

background image

Reference

5

shConnectDefault

This function establishes a connection with the first Signal Hawk RF
Module found.

int BIRD_SH_API shConnectDefault(shConnection_t* Connection);

Arguments

Returns

Note:

Returns an error code indicating the status of the

operation:

Remarks

Call shDisconnect(…) to release the connection.

shGetDeviceList

This function returns a list of PC Hawk devices physically attached to
the PC.

int BIRD_SH_API 3.2.4 shGetDeviceList(shDevices_t* Devices);

Arguments

Connection

Pointer to a structure of type
shConnection_t to hold the context for
the connection.

ERROR_SUCCESS

Connection was successful.

SH_ERROR_INVALID_
ARGUMENT

One or more of the arguments was not
valid.

SH_ERROR_DEVICE_ALREADY
_CONNECTED

The device is already connected.

SH_ERROR_NO_DEVICE_
ATTACHED

The driver did not find any devices.

SH_ERROR_USB_LIBRARY_
NOT_INITIALIZED

The USB driver library has not been
initialized. Call shInitialize() to load and
initialize the USB libraries before using
other functions of the API.

SH_ERROR_USB_CONNECTION
_FAILED

There was a problem with the USB
driver.

Other Call

shGetLastError() for information on

the specific error.

Devices

Pointer to a structure of type shDevices_t
to hold the list of serial numbers and the
number of devices attached to the PC.
The API populates the structure.