niRFSA_ClearError
ViStatus = niRFSA_ClearError( ViSession vi);
Purpose
Clears the error information associated with the session. If you pass VI_NULL for the vi parameter, the niRFSA_ClearError function clears the error information for the current execution thread.
 |
Note niRFSA_GetError clears the error information after it is retrieved. A call to niRFSA_ClearError is only necessary when a call to niRFSA_GetError is not used to retrieve error information. |
The error information includes a primary error, secondary error, and an error elaboration string.
Parameters
| Input | ||
| Name | Type | Description |
| vi | ViSession | Identifies your instrument session. vi is obtained from the niRFSA_init or the niRFSA_initWithOptions functions and identifies a particular instrument session. |
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 niRFSA_error_message function. To obtain additional information about the error condition, call the niRFSA_GetError function. To clear the error information from the driver, call the niRFSA_ClearError function. The general meaning of the status code is as follows:
|
Meaning | |
|---|---|---|---|---|
| 0 | Success | |||
| Positive Values | Warnings | |||
| Negative Values | Errors |