niRFSG_WaitUntilSettled

NI-RFSG C Function

niRFSG_WaitUntilSettled

C Function Prototype

ViStatus niRFSG_WaitUntilSettled (ViSession vi, ViInt32 maxTimeMilliseconds);

Purpose

Waits until the RF output signal has settled. This function is useful for devices that support on-the-fly configuration changes (changes while in the Generation state). Call this function after making a dynamic change to wait for the output to settle.

You can also call this function after calling the niRFSG_Commit function to wait for changes to settle. The niRFSG_WaitUntilSettled function is not needed after calling the niRFSG_Initiate function because the niRFSG_Initiate function does not return until the output is settled.

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

maxTimeMilliseconds ViInt32 Defines the maximum time the function waits for the output to be settled. If the maximum time is exceeded, this function returns the an error.

If you set this parameter to -1, NI-RFSG waits indefinitely until it is settled. The units are expressed in milliseconds.

Default Value: 10000

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