VTI Instruments EX1629 - Vtex1629_Self_Test_Init

VTI Instruments Corp.
230 EX1629 Command Set
vtex1629_self_test_init
FUNCTION PROTOTYPE
ViStatus vtex1629_self_test_init (ViSession vi);
FUNCTION PARAMETERS
vi = contains a session handle to the instrument. This handle is obtained by the function and remains valid until the
session is closed.
DATA ITEM RESET VALUE
Not applicable to this function.
DESCRIPTION
This function initiates a self-test. It returns immediately, without waiting for the self-test to complete. The
vtex1629_self_test_get_status is used to monitor the self-test progress. The vtex1629_self_test function initiates the
self-test and waits until the test has completed before returning.
Because it modifies the system configuration, an instrument synch (vtex1629_soft_synch) will be required before
continuing with other operations.
EXAMPLE
ViStatus status;
ViSession instrumentHandle;
…
status = vtex1629_self_test_init (instrumentHandle);
if (status < VI_SUCCESS)
{
<inform the user the API call failed>
}