niFgen_ErrorMessage
ViStatus niFgen_ErrorMessage (ViSession vi, ViStatus errorCode, ViChar[] errorMessage);
Purpose
Converts a status code returned by an NI-FGEN function into a user-readable string.
Parameters
| Input | ||
| Name | Type | Description |
| vi | ViSession | Identifies your instrument session. vi is obtained from the niFgen_init or the niFgen_InitWithOptions functions and identifies a
particular instrument session.
You can pass VI_NULL for this parameter. Passing VI_NULL is useful when one of the initialize functions fail. Default Value: VI_NULL |
| errorCode | ViStatus | Specifies the status parameter that is returned from any of the NI-FGEN functions.
Default Value: 0 (VI_SUCCESS) |
| Output | ||
| Name | Type | Description |
| errorMessage | ViChar[] | Returns the error message string read from the instrument error message queue.
You must pass a ViChar array with at least 256 bytes. |
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 can examine the status code from each call to an NI-FGEN function to determine if an error occurred.
To obtain a text description of the status code, call the niFgen_error_message function. To obtain additional information about the error condition, call the niFgen_GetError function. To clear the error information from NI-FGEN, call the niFgen_ClearError function. The general meaning of the status code is as follows:
|