Section 7; Function Calls; Introduction; Function Return Value - VTI Instruments EX1000A User Manual

F C
UNCTION ALLS
I
NTRODUCTION
This section presents the instrument function set. It begins by listing the APIs according to function
and is then followed by an alphabetical listing. With each function is a brief description. The
remainder of this section is devoted to describing each function in detail. Each function entry
provides the function prototype, the use and range of parameters, and a description of the function's
purpose.
F R V
UNCTION ETURN
Each function will return a status that will contain either VI_SUCCESS or an error status returned
by the function call.
Error Messages section found later in the chapter for possible error codes. If the
vtex10xxA_error_message function call is used, it will return a description of the error code returned
by the last function call made.
A F
LPHABETICAL UNCTION
The following table provides a summary of the APIs used by the EX10xxA along with an
abbreviated description of the function. The pages following this table are definitions that provide
in-depth detail for each API. A sample API definition is provided immediately following this table
to illustrate what each section of the definition describes.
API
vtex10xxA_abort
vtex10xxA_append_scanlist
vtex10xxA_break_lock
vtex10xxA_check_lock
vtex10xxA_clear_lan_eventlog
vtex10xxA_close
vtex10xxA_disable_streaming_data
vtex10xxA_enable_streaming_data
vtex10xxA_enable_streaming_dataEx
vtex10xxA_error_message
vtex10xxA_error_query
vtex10xxA_get_accum_limit_status
vtex10xxA_get_alarm
vtex10xxA_get_alarm_enable
EX10xxA Function Calls
ALUE
S
ET
www.vtiinstruments.com
S

ECTION

Description
Aborts the current acquisition.
Adds channels onto the end of an existing scan
list.
Breaks a lock on the instrument.
Returns the lock status of the instrument.
Clears event log entries in the instrument.
Closes an instrument programming session.
Disables data streaming.
Enables data streaming.
Enables data streaming (compatible with EX1048

function calls).

Outputs the error message associated with the
errCode parameter.
Outputs the error code and error message obtained
from the instrument.
Returns the accumulated limit status of all 48
channels.
Returns the LXI alarm, time, interval and count
for the alarm source event.
Returns the enabled status of the LXI alarm
7
125