AMETEK Ls Series Driver Manual - Manual (Page 173)

IVI Driver Manual Lx / Ls Series
169
If the error description, including the terminating NUL byte,
contains more bytes than you indicate in this parameter, the function
copies BufferSize - 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
buffer regardless of the number of bytes in the value.
If you pass 0, you can pass VI_NULL for the Description buffer
parameter.
Default Value: None
description
Variable Type ViChar[]
Returns the error description for the IVI session or execution
thread. If there is no description, 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 error description,
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.
If you pass 0 for the Buffer Size, you can pass VI_NULL for this
parameter.
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_GetError function. To clear the
error information from the driver, call the ciLxs_ClearError
function.