VTI Instruments EX1629, User Manual

Page: 224 / 346

VTI Instruments Corp.
224 EX1629 Command Set
vtex1629_self_cal_is_running
F
UNCTION
P
ROTOTYPE
ViStatus vtex1629_self_cal_is_running (ViSession vi , ViPBoolean isRunning );
F
UNCTION
P
ARAMETERS
vi = contains a session handle to the instrument. This handle is obtained by the function and remains valid until the
session is closed.
isRunning = a Boolean return value indicating whether self-calibration is running. A return value of “1” indicates
that self-calibration is running, whereas “0” indicates that it is not.
D
ATA
I
TEM
R
ESET
V
ALUE
Not applicable to this function.
D
ESCRIPTION
This function queries the status of self-calibration to determine if self-calibration is currently running.
E
XAMPLE
ViSession instrumentHandle;
ViStatus status;
ViBoolean isrunning;
ViInt32 count = 0;
…
<start self calibration with vtex1629_self_cal_init>
…
while(count < 30) {
status = vtex1629_self_cal_is_running (instrumentHandle, &isrunning);
if (status >= VI_SUCCESS) {
if( isrunning ) {
sleep(5);
} else {
break;
}
} else {
<inform the user the API call failed>
}
count += 1;
}