niRFSG_error_message
C Function Prototype
ViStatus niRFSG_error_message (ViSession vi, ViStatus errorCode, ViChar[] errorMessage);
Purpose
Converts an error code returned by an NI-RFSG function into a user-readable string.
Supported Devices: NI 5650/5651/5652/5670/5671/5672
Parameters
| Input | ||
| Name | Type | Description |
| vi | ViSession | The ViSession handle that you obtain from niRFSG_init or niRFSG_InitWithOptions. The handle identifies a particular instrument session. You can pass VI_NULL for this parameter. Passing VI_NULL is useful when niRFSG_init or niRFSG_InitWithOptions fails. Default Value: VI_NULL |
| errorCode | ViStatus | Pass the status parameter that is returned from any NI-RFSG function. Default Value: 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. 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:
|