niRFSG_error_query

NI-RFSG C Function

niRFSG_error_query

C Function Prototype

ViStatus niRFSG_error_query (ViSession vi, ViInt32 *Error_Code, ViChar Error_Message[]);

Purpose

Reads an error code and an error message from the instrument error queue.

Parameters

Input
Name Type Description
vi ViSession Identifies your instrument session. The ViSession handle is obtained from the niRFSG_init function or the niRFSG_InitWithOptions function and identifies a particular instrument session.

Default Value: None

Output
Name Type Description
Error_Code ViInt32* Returns the error code read from the instrument error queue.
Error_Message ViChar[] Returns the error message string read from the instrument error message queue.

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. 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 niRFSG_error_message function. To obtain additional information about the error condition, call the niRFSG_GetError function. To clear the error information from the driver, call the niRFSG_ClearError function.

The general meaning of the status code is as follows:

ValueMeaning
0Success
Positive ValuesWarnings
Negative ValuesErrors