VTI Instruments EX1000A, User Manual

Page: 145 / 320

www.vtiinstruments.com
EX10xxA Function Calls 145
vtex10xxA_get_alarm
F
UNCTION
P
ROTOTYPE
ViStatus _VI_FUNC vtex10xxA_get_alarm(ViSession vi , ViPReal64 timeSeconds , ViPReal64 timeFraction ,
ViPReal64 timePeriod , ViPInt32 count );
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.
timeSeconds = a real output value indicating the time (in seconds) when the timer starts. Valid return values: All
positive whole numbers.
timeFraction = a real output value indicating the fractional part of time (in seconds) when the timer starts. Valid
return values: 0.0 to 0.999999999.
timePeriod = a real output value indicating the time (in seconds) between timer ticks. Valid return values: 0.001 to
4294.0.
count = an integer output value indicating the number of timer ticks. Valid return values: 0.
D
ATA
I
TEM
R
ESET
V
ALUE
Not applicable to this function.
D
ESCRIPTION
This function returns the LXI alarm, time, interval and count for the alarm source event. The same value is used for
both arm and trigger events. Note, the count property is not currently supported and is included for future expansion.
It currently always returns “0”, implying that the alarm fires constantly.
E
XAMPLE