beautypg.com

AMETEK Ls Series Driver Manual User Manual

Page 171

background image

IVI Driver Manual

Lx / Ls Series

167

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.

The general meaning of the status code is as follows:

Value Meaning
-------------------------------
0 Success
Positive Values Warnings
Negative Values Errors

This driver defines the following status codes:

Status Description
-------------------------------------------------
ERRORS:
BFFA1001 The trigger source is not software trigger.

This instrument driver also returns errors and warnings defined by
other sources. The following table defines the ranges of additional
status codes that this driver can return. The table lists the
different include files that contain the defined constants for the
particular status codes:

Numeric Range (in Hex) Status Code Types
-------------------------------------------------
3FFA0000 to 3FFA1FFF IVI Warnings
3FFF0000 to 3FFFFFFF VISA Warnings
3FFC0000 to 3FFCFFFF VXIPnP Driver Warnings

BFFA0000 to BFFA1FFF IVI Errors
BFFF0000 to BFFFFFFF VISA Errors
BFFC0000 to BFFCFFFF VXIPnP Driver Errors


________________________________________________________________________________

This manual is related to the following products: