AMETEK Ls Series Driver Manual - Manual (Page 172)

IVI Driver Manual Lx / Ls Series
168
ciLxs_GetError
ViStatus ciLxs_GetError (ViSession instrumentHandle, ViPStatus code,
ViInt32 bufferSize,
ViChar _VI_FAR description[]);
Purpose
This function retrieves and then clears the IVI error information for the
session or the current execution thread. One exception exists: If the
BufferSize parameter is 0, the function does not clear the error
information. By passing 0 for the buffer size, the caller can ascertain
the buffer size required to get the entire error description string and
then call the function again with a sufficiently large buffer.
If the user specifies a valid IVI session for the InstrumentHandle
parameter, Get Error retrieves and then clears the error information for
the session. If the user passes VI_NULL for the InstrumentHandle
parameter, this function retrieves and then clears the error information
for the current execution thread. If the InstrumentHandle parameter is
an invalid session, the function does nothing and returns an error.
Normally, the error information describes the first error that occurred
since the user last called ciLxs_GetError or ciLxs_ClearError.
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
code
Variable Type ViStatus (passed by reference)
Returns the error code for the session or execution thread.
If you pass 0 for the Buffer Size, you can pass VI_NULL for this
parameter.
bufferSize
Variable Type ViInt32
Pass the number of bytes in the ViChar array you specify for the
Description parameter.