VTI Instruments EX1629 - Vtex1629_Init

VTI Instruments Corp.
198 EX1629 Command Set
vtex1629_init
FUNCTION PROTOTYPE
ViStatus vtex1629_init (ViRsrc resourceName, ViBoolean IDQuery, ViBoolean resetEX1629, ViPSession vi);
FUNCTION PARAMETERS
resourceName = this parameter must contain a unique descriptor for the EX1629 to which a session is to be opened.
Part of this descriptor is the IP address of the instrument to which the user will connect. See Description below for
more information.
IDQuery = specifies if an identification query will be sent to the instrument. Valid input values: VI_FALSE or
VI_TRUE.
resetEX1629 = determines whether a reset command will be issued to the instrument upon initialization. Valid input
values: VI_FALSE or VI_TRUE.
vi = this output parameter holds the session handle to the instrument described by the input parameter
resourceName. If vtex1629_init fails, the location pointed to by this parameter will contain a value of zero.
DATA ITEM RESET VALUE
Not applicable to this function.
DESCRIPTION
This function opens a session with the instrument and returns a session handle. It can optionally perform an
identification query and/or reset the instrument to its default state. If VI_TRUE is passed to the IDQuery parameter,
an identification query will be made upon initialization. This is done as a protective measure to ensure that the
instrument specified by the provided IP address is actually an EX1629. If a VI_TRUE is passed to the resetEX1629
parameter, the instrument will be reset upon connection, putting it into a known, default configuration. If a
VI_FALSE is passed for either parameter, the respective operation will not be performed upon initialization.
The format for the resourceName parameter is as follows:
‘TCPIP::y::INSTR’
where y is the IP address or hostname of the instrument where a connection is desired (e.g.
‘TCPIP::10.1.1.216::INSTR’ specifies an instrument connected at the IP address of 10.1.1.216).
EXAMPLE
ViStatus status;
ViSession instrumentHandle;
ViRsrc instrumentName = “TCPIP::169.128.1.2::INSTR”;
…
status = vtex1629_init (instrumentName, VI_TRUE, VI_TRUE, &instrumentHandle);