beautypg.com

Cilxs_abort – AMETEK Ls Series Driver Manual User Manual

Page 16

background image

IVI Driver Manual

Lx / Ls Series

12

ciLxs_Abort


ViStatus ciLxs_Abort (ViSession instrumentHandle);

Purpose

This function aborts all pending output changes.



Parameter List

instrumentHandle

Variable Type ViSession

The ViSession handle that you obtain from the ciLxs_init or
ciLxs_InitWithOptions function. The handle identifies a particular
instrument session.

Default Value: None


Return Value

Returns the status code of this operation. The status code either
indicates success or describes an error or warning condition. You
examine the status code from each call to an instrument driver
function to determine if an error occurred.

To obtain a text description of the status code, call the
ciLxs_error_message function. To obtain additional information about
the error condition, call the ciLxs_GetError function. To clear the
error information from the driver, call the ciLxs_ClearError
function.

The general meaning of the status code is as follows:

Value Meaning
-------------------------------
0 Success
Positive Values Warnings
Negative Values Errors


This driver defines the following status codes:

Status Description
-------------------------------------------------
ERRORS:
BFFA1001 The trigger source is not software trigger.

This instrument driver also returns errors and warnings defined by
other sources. The following table defines the ranges of additional
status codes that this driver can return. The table lists the
different include files that contain the defined constants for the
particular status codes:

This manual is related to the following products: