rfsa c api reference

niRFSA_CalAdjustDeviceGain

  • Updated2024-05-08
  • 1 minute(s) read

niRFSA_CalAdjustDeviceGain

ViStatus niRFSA_CalAdjustDeviceGain(ViSession vi, ViConstString channelList, ViReal64 frequency, ViReal64 gain);

Purpose

Records measured gain information that is gathered during the Reference Level Calibration step and IF Attenuation Calibration step.

This function internally queries the attributes you set, and you must commit all attributes appropriate for your device calibration procedure prior to calling this function. Refer to ni.com/manuals for the most recent version of the calibration procedure for your device.

Call this function immediately after a measurement is made and while the device under test (DUT) is still in the same state as it was during the measurement.

Supported Devices: PXIe-5693/5694/5698

Parameters

Input
Name Type Description
vi ViSession Identifies your instrument session. vi is obtained from the niRFSA_init or niRFSA_InitWithOptions function.
channelList ViConstString Identifies which channels to apply settings. Specify 0 as the value of this parameter.
frequency ViReal64 Specifies the RF frequency, in Hz, of the measurement taken.
gain ViReal64 Specifies the gain measurement, in dB.

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 NI-RFSA function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the niRFSA_GetError function. To clear the error information from NI-RFSA, 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

Log in to get a better experience