TMS International BV

GetConnectionProperties

BOOL GetConnectionPropertie( 
	HANDLE Handle, 
	int *SignalStrength,
	unsigned int *NrOfCRCErrors, 
	unsigned int *NrOfSampleBlocks ) 

Parameters

Handle
    Handle of the library
SignalStrength
    For WLAN connections : the signal strength of the connection to the frontend, between 0 and 100.
    For USB connections : the signal strength is not available and the variable is set to -1.
    For Bluetooth connections : the signal strength is not available and the variable is set to -1.

NrOfCrcErrors
    The number of CRC errors in the received data blocks from the Frontend since the last call of Start().
NrOfSampleBlocks
    The number received data blocks from the Frontend since the last call of Start().

    

Return Value

If successful this function returns TRUE. If the function return FALSE, use GetErrorCode to get the error code.

Comments

The Open function must have been called before.

It is recommended to call this function only when the frontend is not sampling, i.e. do NOT call this function when Start() is called, and Stop() is not called yet.

The Start() function resets the NrOfSampleBlocks and NrOfCrcErrors counters.

Data blocks are send with a Cyclic Redundancy Check (CRC) to the PC. In this way, it is verified if the data has been corrupted during the data transport from the frontend to the PC. When a  CRC error is found, the data block is discarded, and the NrOfCRCErrors counter is incremented.

Also see

Open