VTI Instruments EX1000A - Function Calls Overview

www.vtiinstruments.com
EX10xxA Function Calls 125
SECTION 7
FUNCTION CALLS
INTRODUCTION
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.
FUNCTION RETURN VALUE
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.
ALPHABETICAL FUNCTION SET
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
Description
vtex10xxA_abort
Aborts the current acquisition.
vtex10xxA_append_scanlist
Adds channels onto the end of an existing scan
list.
vtex10xxA_break_lock
Breaks a lock on the instrument.
vtex10xxA_check_lock
Returns the lock status of the instrument.
vtex10xxA_clear_lan_eventlog
Clears event log entries in the instrument.
vtex10xxA_close
Closes an instrument programming session.
vtex10xxA_disable_streaming_data
Disables data streaming.
vtex10xxA_enable_streaming_data
Enables data streaming.
vtex10xxA_enable_streaming_dataEx
Enables data streaming (compatible with EX1048
function calls).
vtex10xxA_error_message
Outputs the error message associated with the
errCode parameter.
vtex10xxA_error_query
Outputs the error code and error message obtained
from the instrument.
vtex10xxA_get_accum_limit_status
Returns the accumulated limit status of all 48
channels.
vtex10xxA_get_alarm
Returns the LXI alarm, time, interval and count
for the alarm source event.
vtex10xxA_get_alarm_enable
Returns the enabled status of the LXI alarm