IviRFSigGen_WaitUntilSettled
IviRFSigGenBase Capability Group
C Function Prototype
ViStatus IviRFSigGen_WaitUntilSettled (ViSession vi, ViInt32 maxTime);
Purpose
This function waits until the state of the RF output signal has settled.
Parameters
| Name | Type | Description |
|---|---|---|
| vi | ViSession | The ViSession handle that you obtain from the IviRFSigGen_init or IviRFSigGen_InitWithOptions function. The handle identifies a particular instrument session. Default Value: None |
| maxTime | ViInt32 | Specifies the maximum time to wait for the output to settle.
If the output does not settle within this time interval, the function returns the IVIRFSIGGEN_ERROR_MAX_TIME_EXCEEDED (0xBFFA2003) error code. Units: milliseconds Defined Values: IVIRFSIGGEN_VAL_MAX_TIME_INFINITE (-1) IVIRFSIGGEN_VAL_MAX_TIME_IMMEDIATE (0) Default Value: 5000 (ms) Notes: (1) The Maximum Time parameter applies only to this function. It has no effect on other timeout parameters or attributes. |