IVI Compliance Package

Table of Contents
  • IVI Compliance Package
  • IVI Driver Help Introduction
  • IVI Class Driver Help

IviUpconverter_ConfigureListDwell

ViStatus IviUpconverter_ConfigureListDwell (ViSession instrumentHandle, ViBoolean singleStepEnabled, ViReal64 listDwell_s);

Purpose

This function configures the list stepping.

Parameters

Input
Name Type Description
instrumentHandle ViSession The ViSession handle that you obtain from the IviUpconverter_init or IviUpconverter_InitWithOptions function.  The handle identifies a particular instrument session.
Default Value:  None
singleStepEnabled ViBoolean Enables or disables single step mode. The driver uses this value to set the IVIUPCONVERTER_ATTR_LIST_SINGLE_STEP_ENABLED attribute.
Valid Values:
VI_TRUE - Enables single step mode.
VI_FALSE - Disables single step mode.
Default Value: VI_FALSE
listDwell_s ViReal64 Specifies the duration of one step. The driver uses this value to set the IVIUPCONVERTER_ATTR_LIST_DWELL attribute.
Units: Seconds
Default Value: 1.0 s
Note: This value is valid only when IVIUPCONVERTER_ATTR_LIST_SINGLE_STEP_ENABLED is VI_FALSE.

Return Values

Log in to get a better experience