The ser_sr24_verify_connection function verifies that we have a good connection to
the serial board. It 'pings' the board and waits for the board to respond. If the
board is not present or is unable to respond to the ping, this function will time out
and return an error code. The timeout period is also adjustable by the programmer.
See the ser_sr24_set_timeout() function for
details.
Parameters
handle:
This is the handle to the serial board; it is actually a pointer to the data
structure for the board.
Return Values
The function returns 0 if the connection is good. Possible error codes include:
SER_TIMEOUT - Timed out waiting for response. Connection
has been lost (unless the timeout value has been
set way too low)
SER_INVALID_HANDLE - returned if a NULL pointer was passed
for the handle
Visual Basic Notes
The Visual Basic equivalent of this function is the VerifyConnection method.
Return values are listed above.