beautypg.com

Shdisconnect, Remarks, Arguments returns – Bird Technologies SignalHawk User Manual

Page 19

background image

Reference

7

Remarks

Call shGetDeviceList(…) to get a list of available PC Hawk devices.
The shDevices_t structure returned by shGetDeviceList() contains a
list of serial numbers.

Call shDisconnect(…) to release the connection.

Note:

Only one device can be connected at a time.

shDisconnect

This function disconnects from the Signal Hawk RF Module.

int BIRD_SH_API shDisconnect(shConnection_t* Connection);

Arguments

Returns

Note:

Returns an error code indicating the status of the

operation:

SH_ERROR_USB_SELECTED_
DEVICE_NOT_FOUND

The driver did not find the requested
device.

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.

Connection

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

ERROR_SUCCESS

Initialization was successful.

SH_ERROR_INVALID_
ARGUMENT

One or more of the arguments was not
valid.

SH_ERROR_DEVICE_NOT_
CONNECTED

No device is connected.

SH_ERROR_SELECTED_
DEVICE_NOT_CONNECTED

The specified device is not connected.

Others Call

shGetLastError() for information on

the specific error.