Bird Technologies SignalHawk - Manual (Page 18)

Bird Technologies
6
Returns
Returns an error code indicating the status of the operation:
Remarks
Call shConnect(…) to connect to one of the devices. Only one
device may be connected at a time.
shConnect
This function establishes a connection with the specified Signal Hawk
RF Module.
int BIRD_SH_API shConnect(
shConnection_t* Connection,
char* DeviceName
);
Arguments
Returns
Returns an error code indicating the status of the operation:
ERROR_SUCCESS Operation was successful.
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.
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.
DeviceName A character string containing the serial
number of the specifed PC Hawk.
ERROR_SUCCESS Connection was successful.
SH_ERROR_INVALID_ARGUME
NT 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.