VTI Instruments EX1000A, User Manual

Page: 221 / 320

www.vtiinstruments.com
EX10xxA Function Calls 221
vtex10xxA_set_alarm
F
UNCTION
P
ROTOTYPE
ViStatus _VI_FUNC vtex10xxA_set_alarm( ViSession vi , ViReal64 timeSeconds , ViReal64 timeFraction ,
ViReal64 timePeriod , ViInt32 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 input value indicating the whole part of the IEEE1588 time (in seconds) at which the timer
starts. Valid input values: Whole numbers 0 through 4294967296.
timeFraction = a real input value indicating the fractional part of the IEEE1588 time (in seconds) at which the timer
starts. Valid return values: 0.0 through 0.999999999.
timePeriod = a real input value indicating the time (in seconds) between timer ticks. Valid input values: 0.001 to
4294.0.
count = an integer input value indicating the number of timer ticks. Note that a value of “0” indicates forever. Valid
input values: 0.
D
ATA
I
TEM
R
ESET
V
ALUE
timeSeconds = 0.0 timeFraction = 0.0
timePeriod = 0.1 count = 0
D
ESCRIPTION
This function sets the alarm time, period, and count for the LXI alarm source event. The same value is used for both
arm and trigger events. The
count property is currently unsupported but is provided in this API for future expansion.
Currently, the only valid value is “0”.
E
XAMPLE