niRFSG_PerformThermalCorrection

NI-RFSG C Function

niRFSG_PerformThermalCorrection

C Function Prototype

ViStatus niRFSG_PerformThermalCorrection (ViSession vi);

Purpose

Corrects for any signal drift due to environmental temperature variation when generating the same signal for extended periods of time without a parameter change. NI-RFSG compensates automatically for variations in device temperature when any signal generation parameters are changed. Under normal circumstances of short-term signal generation, NI-RFSG automatic compensation ensures stable power levels, and you do not need to use this function.

Use this function when generating the same signal for an extended period of time in a temperature-fluctuating environment. The NI-RFSG device must be in the Generation state before calling this function.

Supported Devices: 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

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:

ValueMeaning
0Success
Positive ValuesWarnings
Negative ValuesErrors