AMETEK Ls Series Driver Manual - Manual (Page 179)

IVI Driver Manual Lx / Ls Series
175
buffer regardless of the number of bytes in the value.
If you pass 0, you can pass VI_NULL for the Interchange Warning
buffer parameter.
Default Value: None
interchangeWarning
Variable Type ViChar[]
Returns the next interchange warning for the IVI session. If there
are no interchange warnings, the function returns an empty string.
The buffer must contain at least as many elements as the value you
specify with the Buffer Size parameter. If the next
interchangeability warning string, including the terminating NUL
byte, contains more bytes than you indicate with the Buffer Size
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.
This parameter returns an empty string if no interchangeability
warnings remain for the session.
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.
If the current value of the return buffer, including the terminating
NUL byte, is larger than the size you indicate in the Buffer Size
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.
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_GetErrorInfo function. To clear
the error information from the driver, call the ciLxs_ClearErrorInfo
function.
The general meaning of the status code is as follows:
Value Meaning
-------------------------------
0 Success
Positive Values Warnings