IviSwtch_WaitForScanComplete
IviSwtchScanner Capability Group
C Function Prototype
ViStatus IviSwtch_WaitForScanComplete (ViSession vi, ViInt32 maxTime);
Purpose
This function waits until the instrument stops scanning or the time you specified has elapsed. If the switch module is not currently scanning through the scan list, this function returns the IVISWTCH_ERROR_NO_SCAN_IN_PROGRESS error. If the time you specified elapses before the instrument stops scanning, this function returns a timeout error.
Parameters
| Name | 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. |
| maxTime | ViInt32 | Specifies the maximum length of time for this function to wait until the instrument stops scanning. If the time you specify elapses before it stops scanning, this function returns a timeout error. The units are milliseconds. |