AMETEK Ls Series Driver Manual - Manual (Page 178)

IVI Driver Manual Lx / Ls Series
174
ciLxs_GetNextInterchangeWarning
ViStatus ciLxs_GetNextInterchangeWarning (ViSession instrumentHandle,
ViInt32 bufferSize,
ViChar _VI_FAR
interchangeWarning[]);
Purpose
This function returns the interchangeability warnings associated with the
IVI session. It retrieves and clears the oldest instance in which the
class driver recorded an interchangeability warning. Interchangeability
warnings indicate that using your application with a different instrument
might cause different behavior. You use this function to retrieve
interchangeability warnings.
The driver performs interchangeability checking when the
CILXS_ATTR_INTERCHANGE_CHECK attribute is set to VI_TRUE.
The function returns an empty string in the Interchange Warning parameter
if no interchangeability warnings remain for the session.
In general, the instrument driver generates interchangeability warnings
when an attribute that affects the behavior of the instrument is in a
state that you did not specify.
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
bufferSize
Variable Type ViInt32
Pass the number of bytes in the ViChar array you specify for the
Interchange Warning parameter.
If the next interchangeability warning string, including the
terminating NUL byte, contains more bytes than you indicate in this
parameter, the function copies Buffer Size - 1 bytes into the buffer,
places an ASCII NUL byte at the end of the buffer, and returns the
buffer size you must pass to get the entire value. For example, if
the value is "123456" and the Buffer Size is 4, the function places
"123" into the buffer and returns 7.
If you pass a negative number, the function copies the value to the