pi40iv_GetErrorInfo

ViStatus pi40iv_GetErrorInfo (ViSession instrumentHandle, ViPStatus primaryError, ViPStatus secondaryError, ViChar _VI_FAR errorElaboration[]);

Purpose

This function returns the error information associated with an IVI session or with the current execution thread.  If you specify a valid IVI session for the Instrument Handle parameter, this function retrieves and then clears the error information for the session.  If you pass VI_NULL for the Instrument Handle parameter, this function retrieves and then clears the error information for the current execution thread.
The error information includes a primary error, secondary error, and an error elaboration string.  For a particular session, this information is the same as the values held in the following attributes:
PI40IV_ATTR_PRIMARY_ERROR
PI40IV_ATTR_SECONDARY_ERROR
PI40IV_ATTR_ERROR_ELABORATION
The IVI Library also maintains this error information separately for each thread.  This is useful if you do not have a session handle to pass to pi40iv_GetErrorInfo or pi40iv_ClearErrorInfo, which
occurs when a call to pi40iv_init or pi40iv_InitWithOptions fails.
You can call pi40iv_error_message to obtain a text description of the primary or secondary error value.

Parameters

Input
Name	Type	Description
instrumentHandle	ViSession	The ViSession handle that you obtain from the pi40iv_init or pi40iv_InitWithOptions function. The handle identifies a particular instrument session. Default Value: VI_NULL
Output
Name	Type	Description
primaryError	ViStatus (passed by reference)	The primary error code for the session or execution thread. The value is the same as the one held by the attribute PI40IV_ATTR_PRIMARY_ERROR. A value of VI_SUCCESS (0) indicates that no error occurred, A positive value indicates a warning. A negative value indicates an error. You can call pi40iv_error_message to get a text description of the value. If you are not interested in this value, you can pass VI_NULL.
secondaryError	ViStatus (passed by reference)	The secondary error code for the session or execution thread. If the primary error code is non-zero, the secondary error code can further describe the error or warning condition. The value is the same as the one held by the attribute PI40IV_ATTR_SECONDARY_ERROR. A value of VI_SUCCESS (0) indicates no further description. You can call pi40iv_error_message to get a text description of the value. If you are not interested in this value, you can pass VI_NULL.
errorElaboration	ViChar[]	The error elaboration string for the session or execution thread. If the primary error code is non-zero, the elaboration string can further describe the error or warning condition. The value is the same as the one held by the attribute PI40IV_ATTR_ERROR_ELABORATION. If you are not interested in this value, you can pass VI_NULL. Otherwise, you must pass a ViChar array with at least 256 bytes.

Return Value

Name	Type	Description
status	ViStatus	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. To obtain a text description of the status code, call the pi40iv_error_message function. To obtain additional information about the error condition, call the pi40iv_GetErrorInfo function. To clear the error information from the driver, call the pi40iv_ClearErrorInfo 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 ------------------------------------------------- WARNINGS: /=CHANGE:=================================================== Insert Instrument-defined warning codes here. ================================================END=CHANGE=/ ERRORS: /=CHANGE:=================================================== Insert Instrument-defined error codes here. ================================================END=CHANGE=/ 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 ------------------------------------------------- 3FFA2000 to 3FFA3FFF IviSwtch Warnings 3FFA0000 to 3FFA1FFF IVI Warnings 3FFF0000 to 3FFFFFFF VISA Warnings 3FFC0000 to 3FFCFFFF VXIPnP Driver Warnings BFFA2000 to BFFA3FFF IviSwtch Errors BFFA0000 to BFFA1FFF IVI Errors BFFF0000 to BFFFFFFF VISA Errors BFFC0000 to BFFCFFFF VXIPnP Driver Errors

References

Error Info
Utility
Pickering Interfaces PXI/LXI IVI Switch
Alphabetical Function Index
Hierarchical Function Index