IviRFSigGen_ConfigureListDwell
IviRFSigGenList Capability Group
C Function Prototype
ViStatus IviRFSigGen_ConfigureListDwell (ViSession vi, ViBoolean singleStepEnabled, ViReal64 dwell);
Purpose
This function configures how list stepping advances.
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 |
| singleStepEnabled | ViBoolean | Specifies if the list step advances after the next trigger event (VI_TRUE) or immediately after the dwell time ends (VI_FALSE). Valid Values: VI_TRUE - The list advances when the next trigger event occurs. VI_FALSE - The list will advance immediately after the dwell time ends. The driver uses this value to set the IVIRFSIGGEN_ATTR_LIST_SINGLE_STEP_ENABLED attribute. Default Value: VI_FALSE |
| dwell | ViReal64 | Specifies the duration time of one step. The driver uses this value to set the IVIRFSIGGEN_ATTR_LIST_DWELL attribute. Units: Seconds Default Value: 2.0 ms Notes: (1) This attribute is ignored if List Single Step Enabled is set to VI_TRUE. |