niRFSG_ClearError
C Function Prototype
ViStatus niRFSG_ClearError (ViSession vi);
Purpose
Clears the error information associated with the session. If you pass VI_NULL for the vi parameter, this function clears the error information for the current execution thread.
 |
Note The niRFSG_GetError function clears the error information after it is retrieved. A call to the niRFSG_ClearError function is only necessary when a call to the niRFSG_GetError function is not used to retrieve error information. |
The IVI Engine also maintains this error information separately for each thread. This feature is useful if you do not have a session handle to pass to the niRFSG_ClearError function or the niRFSG_GetError function, which occurs when a call to the niRFSG_init function or the niRFSG_InitWithOptions function fails.
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 |
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:
|