niRFSA_ClearError
- Updated2025-02-03
- 1 minute(s) read
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, this function clears the error information for the current execution thread.
 |
Note The niRFSA_GetError function clears the error information after it is retrieved. A call to the niRFSA_ClearError function is necessary only when a call to the niRFSA_GetError function is not used to retrieve error information. |
Supported Devices: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5693/5694/5698, PXIe-5820/5840
Parameters
| Input | ||
| Name | Type | Description |
| vi | ViSession | Identifies your instrument session. vi is obtained from the niRFSA_init or niRFSA_InitWithOptions function. |
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 NI-RFSA function to determine if an error has occurred. To obtain a text description of the status code and additional information about the error condition, call the niRFSA_GetError function. To clear the error information from NI-RFSA, call the niRFSA_ClearError function. The general meaning of the status code is as follows:
|
||||||||