niRFSA_error_message
ViStatus = niRFSA_error_message( ViSession vi, ViStatus statusCode, ViChar message[]);
Purpose
Converts a status code returned by an NI-RFSA function into a user-readable 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. |
| errorCode | ViStatus | Pass the status parameter that is returned from any NI-RFSA function. The default value is 0 (VI_SUCCESS). |
| Output | ||
| Name | Type | Description |
| errorMessage | ViChar[] | Returns the user-readable message string that corresponds to the status code you specify. You must pass a ViChar array with at least 256 bytes to this parameter. |
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 |