VTI Instruments EX1629 - Vtex1629_Self_Cal_Get_Status

www.vtiinstruments.com
EX1629 Command Set 221
vtex1629_self_cal_get_status
FUNCTION PROTOTYPE
ViStatus vtex1629_self_cal_get_status (ViSession vi, ViPInt32 percentComplete, ViPInt32 calStatus);
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.
percentComplete = an integer return value, from 0 to 100, indicating a percentage of completion for the self-
calibration process.
calStatus = an integer return value indicating the status of the currently running self-calibration process, or the last
self-calibration process that was run, and completed. Expected data return values: 0, 1, or 2.
DATA ITEM RESET VALUE
Not applicable to this function.
DESCRIPTION
This function returns the status of the self-calibration process. This will be the status of the currently running self-
calibration routine, or the last self-calibration routine that was completed.
The calStatus parameter indicates the following:
0 = Self-calibration in progress 1 = Self-calibration complete
2 = Self-calibration failed.
NOTE Additional instrument driver calls should not be performed until the result of calStatus is equal to
VTEX1629_SELF_CAL_COMPLETE.
EXAMPLE
ViSession instrumentHandle;
ViStatus status;
ViInt32 percent;
ViInt32 calstatus;
…
status = vtex1629_self_cal_get_status (instrumentHandle, &percent, &calstatus);