IviRFSigGen_ConfigureFrequencyStepDwell

CVI/LabWindows IVI Class Driver

IviRFSigGen_ConfigureFrequencyStepDwell

IviRFSigGenFrequencyStep Capability Group

C Function Prototype

ViStatus IviRFSigGen_ConfigureFrequencyStepDwell (ViSession vi, ViBoolean singleEnabled, ViReal64 dwell);

Purpose

This function configures how the frequency sweep 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

singleEnabled ViBoolean Specify if the frequency sweep advances after the next trigger event (VI_TRUE) or immediately after the dwell time ends (VI_FALSE). The driver uses this value to set the IVIRFSIGGEN_ATTR_FREQUENCY_STEP_SINGLE_STEP_ENABLED attribute.

Valid Values: VI_TRUE; VI_FALSE

Default Value: VI_FALSE

dwell ViReal64 Specify the duration time of one step. Dwell time starts immediate after a trigger or the next step; no settling time is added. The driver uses this value to set the IVIRFSIGGEN_ATTR_FREQUENCY_STEP_DWELL attribute.

Units: Seconds

Default Value: 2.0 ms

Note:

This attribute is ignored if the IVIRFSIGGEN_ATTR_FREQUENCY_STEP_SINGLE_STEP_ENABLED attribute is set to VI_TRUE.

Return Values