beautypg.com

Shsastop, Error codes, Communication errors – Bird Technologies SignalHawk User Manual

Page 34: Arguments returns remarks

background image

Bird Technologies

22

shSaStop

This function stops a sweep.

int BIRD_SH_API shSaStop(

shConnection_t* Connection,
WORD Timeout
);

Arguments

Returns

Returns an error code indicating the status of the operation:

Remarks

shSaStop(…) should be called to terminate all sweep operations.

Error Codes

Communication Errors

33554433 SH_ERROR_DEVICE_ALREADY_CONNECTED
SH Connect Error, Device Already Connected

33554434 SH_ERROR_NO_DEVICE_ATTACHED
SH Error, No Device Attached

33554435 SH_ERROR_INITIALIZE_USB_LIBRARY_FAILED
SH Error, Failed to Initialize USB Library

33554436 SH_ERROR_USB_LIBRARY_NOT_INITIALIZED
SH Error, USB Library Not Initialized

Connection

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

Timeout

Timeout interval in milliseconds.

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.