niRFSG_self_test
C Function Prototype
ViStatus niRFSG_self_test (ViSession vi, ViInt16* selfTestResult, ViChar[] selfTestMessage);
Purpose
Performs a self-test on the NI-RFSG device and returns the test results. This function performs a simple series of tests to ensure that the NI-RFSG device is powered up and responding.
This function does not affect external I/O connections or connections between devices. Complete functional testing and calibration are not performed by this function. The NI-RFSG device must be in the Configuration state before you call this function.
Supported Devices: NI 5610 (upconverter only mode), NI 5650/5651/5652/5670/5671/5672
Parameters
| Input | ||||||||
| Name | Type | Description | ||||||
| vi | ViSession | Identifies your instrument session. The ViSession handle is obtained from the niRFSG_init function or the niRFSG_InitWithOptions function and identifies a particular instrument session. Default Value: None |
||||||
| Output | ||||||||
| Name | Type | Description | ||||||
| selfTestResult | ViInt16* | This parameter contains the value returned from the NI-RFSG device self test.
|
||||||
| selfTestMessage | ViChar[] | Returns the self-test response string from the NI-RFSG device. For an explanation of the string contents, refer to the status parameter of this function.. 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. 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:
|