IviSwtch_IsScanning

CVI/LabWindows IVI Class Driver

IviSwtch_IsScanning

IviSwtchScanner Capability Group

C Function Prototype

ViStatus IviSwtch_IsScanning (ViSession vi, ViBoolean *isScanning);

Purpose

Use this function to determine if the instrument is currently scanning through the scan list or is idle. The switch module's current state is returned in the isScanning parameter.

Parameters

Inputs Type Description
vi ViSession The instrument handle that you obtain from the IviSwtch_init or IviSwtch_InitWithOptions functions. The handle identifies a particular IVI session.
     
Outputs Type Description
isScanning ViBoolean
(passed by
reference)
Indicates the state of the switch module. The driver returns the value of IVISWTCH_ATTR_IS_SCANNING attribute.

The value VI_TRUE indicates that the switch module is scanning.

The value VI_FALSE indicates that the switch module is idle.

Return Values