VTI Instruments EX1000A, User Manual

Page: 153 / 320

www.vtiinstruments.com
EX10xxA Function Calls 153
vtex10xxA_get_arm_sourceEx
F
UNCTION
P
ROTOTYPE
ViStatus _VI_FUNC vtex10xxA_get_arm_sourceEx( ViSession vi , ViInt16 vtb_masks[] ,ViInt16 dio_masks[] ,
ViInt16 lan_masks[] , ViPBoolean timer_enable , ViPBoolean immediate , ViPBoolean alarm );
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.
vtb_masks = a return array of four 8-bit integer values representing the enabled state of trigger events from the eight
channels of the trigger bus. Within the 8-bit field, the MSB corresponds to VTB channel 7 and the LSB corresponds
to VTB channel 0. Valid input values: 0 through 255.
dio_masks = a return array of four 8-bit integer values representing the enabled state of trigger events from the eight
channels of the digital I/O port. Within the 8-bit field, the MSB corresponds to DIO channel 7 and the LSB
corresponds to DIO channel 0. Valid input values: 0 through 255.
lan_masks = an array of four 8-bit integer values representing the enabling of LAN events from any of the eight
LAN events. Within the 8-bit field, the MSB corresponds to LAN 7 and the LSB corresponds to LAN 0. Valid input
values: 0 through 255 (decimal), 0x00 through 0xFF (hexadecimal).
timer_enable = a Boolean value indicating whether the timer is enabled as an arm event. If a “1” is returned for this
parameter, the timer can act as an arm event. If a “0” is returned, the timer is not a valid arm event.
immediate = a Boolean value indicating whether immediate is enabled as an arm event. If a “1” is returned for this
parameter, an immediate arm is enabled. If a “0” is returned, an immediate arm is disabled.
alarm = a Boolean value indicating whether the LXI alarm is used as an ARM event. If a “1” is returned for this
parameter, the LXI alarm can act as an arm event. If a “0” is returned, the LXI alarm is not a valid arm event.
D
ATA
I
TEM
R
ESET
V
ALUE
Not applicable to this function.
D
ESCRIPTION
This function returns the enabled arm source events. For the vtb_masks , dio_masks , and lan_masks parameters,
the data items in these arrays are ordered as follows: positive edge, negative edge, positive level, negative level. For
the
lan_masks parameter, however, the positive and negative levels are not supported with LAN events and these
bits are ignored. Note that any and all of the parameters above can be enabled simultaneously, with the exception of
immediate.
E
XAMPLE