VTI Instruments EX1629 - Vtex1629_Self_Test_Get_Status

www.vtiinstruments.com
EX1629 Command Set 229
vtex1629_self_test_get_status
FUNCTION PROTOTYPE
ViStatus vtex1629_self_test_get_status (ViSession vi, ViPInt32 selfTestStatus);
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.
selfTestStatus = upon return from the function call, it will contain one of the following constants:
VTEX1629_SELF_TEST_NO_STATUS (self-test not started)
VTEX1629_SELF_TEST_RUNNING (self-test started)
VTEX1629_SELF_TEST_PASSED (self-test passed)
VTEX1629_SELF_TEST_FAILED (self-test failed)
DATA ITEM RESET VALUE
Not applicable to this function.
DESCRIPTION
This function returns the status of the self-test initiated via the vtex1629_self_test_init function. It should not be
used (and is not necessary) with the vtex1629_self_test function, as that function does not return until the self-test
has completed. The self-test takes approximately 3 minutes to execute.
Because the self-test modifies the system configuration, an instrument synch (vtex1629_soft_synch) will be required
before continuing with other operations.
EXAMPLE
ViStatus status;
ViSession instrumentHandle;
ViInt16 selfTestResult;
…
status = vtex1629_self_test_get_status (instrumentHandle, &selfTestResult);
if (status < VI_SUCCESS)
{
<inform the user the API call failed>
}
if ((status >= VI_SUCCESS) && (selfTestResult != VTEX1629_SELF_TEST_PASSED))
{
<inform the user the self test failed>
}
if ((status >= VI_SUCCESS) && (selfTestResult == VTEX1629_SELF_TEST_PASSED))
{
<continue normal processing>
}