niSync_self_test

C Function Prototype

ViStatus niSync_self_test (ViSession vi, ViInt16* selfTestResult, ViChar[] selfTestMessage);

Purpose

Runs the NI-Sync module's self test routine and returns the test result(s).

Note  Currently, this operation does nothing.

Parameters

Name Type Description
vi ViSession The session handle that you obtain from niSync_init. The handle identifies a particular instrument session.

selfTestResult ViInt16 This control contains the value returned from the instrument self test:
Self-Test Code Description
0 Self-test passed
1 Self-test failed
selfTestMessage ViChar[] Returns the self-test response string from the instrument. See the device's operation manual for an explanation of the string's contents.

Note  You must pass a ViChar array at least 256 bytes in size.


Return Values