AMETEK Ls Series Driver Manual - Manual (Page 145)

IVI Driver Manual Lx / Ls Series
141
ciLxs_error_query
ViStatus ciLxs_error_query (ViSession instrumentHandle,
ViPInt32 errorCode,
ViChar _VI_FAR errorMessage[]);
Purpose
This function reads an error code and a message from the instrument's
error queue.
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
errorCode
Variable Type ViInt32 (passed by reference)
Returns the error code read from the instrument's error queue.
errorMessage
Variable Type ViChar[]
Returns the error message string read from the instrument's error
message queue.
You must pass a ViChar array with at least 256 bytes.
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.