niRFSA_self_test

NI RF Vector Signal Analyzers

niRFSA_self_test

ViStatus = niRFSA_self_test( ViSession vi, ViInt16 *testResult,/*Output*/ ViChar testMessage[]);

Purpose

Performs a self-test on the NI-RFSA device and returns the test result. This function performs a simple series of tests ensuring the NI-RFSA device is powered up and responding.

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.
Output
Name Type Description
testResult ViInt16* Returns the value from the device self-test. Zero means success.
testMessage[] ViChar Returns the self-test response string from the NI-RFSA device.

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:

Value
Meaning
0 Success
Positive Values Warnings
Negative Values Errors