niSwitch_WaitForScanComplete
IviSwtchScanner Capability Group
C Function Prototype
ViStatus niSwitch_WaitForScanComplete (ViSession vi, ViInt32 maximumTime_ms);
Purpose
Pauses until the switch stops scanning or until the maximum time has elapsed, when NI-SWITCH returns a timeout error.
If the time you specify with the maximumTime_ms parameter elapsed before the scanning operation has finished, this function returns the NISWITCH_ERROR_MAX_TIME_EXCEEDED error.
Parameters
| Name | Type | Description |
|---|---|---|
| vi | ViSession | A particular NI-SWITCH session established with niSwitch_InitWithTopology, niSwitch_InitWithOptions, or niSwitch_init and used for all subsequent NI-SWITCH calls. |
| maximumTime_ms | ViInt32 | Specifies the maximum length of time to wait for the switch module to stop scanning. If the specified time elapses before the scan ends, the NISWITCH_ERROR_MAX_TIME_EXCEEDED error is returned. The default value is 5000 ms. |