next up previous
Next: RTDX_Service Up: Host (PC) RTDX API Previous: Query Functions

Diagnostic Functions



Get channel status


long GetChannelStatus( BSTR ChannelName, long * pChannelStatus )

The GetChannelStatus function returns the current status of the named channel: enabled or disabled.

Parameters:

ChannelName The name of a channel
pChannelStatus Status of the channel
  0 - disabled
  1 - enabled
   
Returns:

long Success
  Failure


Get RTDX version


long GetRTDXRev( long * RevNum )

The GetRTDXRev function returns the version number of your installed RTDX software. The version number is returned in the parameter RevNum.

Parameters:

RevNum Version number.
   
Returns:

long Success
  Failure


Get status string


long GetStatusString( BSTR * StatusString )

The function GetStatusString returns a description of the last error that occurred in the RTDX window. The information is returned in the parameter StatusString.

Parameters:

StatusString Text string.
   
Returns:

long Success
  Failure


Get capability


long GetCapability( long * Capability )

The function GetCapability returns the capability of the RTDX window. The information is returned in the parameter Capability.

Parameters:

none  
   
Returns:

long Success
  Failure


Run diagnostics


long RunDiagnostics(short TestType, long TestMode, long TestInfo)

The RunDiagnostics function performs the specified diagnostic test. The results of the test are returned in the parameter TestInfo.

Parameters:

TestType Types of tests:
  0 - Internal
  1 - Target to Host
  2 - Host to Target
TestMode Test modes:
  0 - Start
  1 - Stop
  2 - Get result
TestInfo Possible outcomes:
  0 - Success
  1 - Failure
  2 - Test Timeout
   
Returns:

long Success
  Failure
   


Get diagnostic file path


BSTR GetDiagFilePath( short TestType )

The GetDiagFilePath function returns the path and filename for the specified diagnostic test.

Parameters:

TestType Types of tests:
  INTERNAL_TEST
  TARGET2HOST_TEST
  HOST2TARGET_TEST
   
Returns:

Fully specified path and filename.



next up previous
Next: RTDX_Service Up: Host (PC) RTDX API Previous: Query Functions
H. Rogalla 2005-12-07