niSwitch_WaitForDebounce

NI-SWITCH Functions

niSwitch_WaitForDebounce

IviSwtchBase Capability Group

C Function Prototype

ViStatus niSwitch_WaitForDebounce (ViSession vi, ViInt32 maximumTime_ms);

Purpose

Pauses until all created paths have settled.

If the time you specify with the maximumTime_ms parameter elapses before the switch paths settle, 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 all relays in the switch module to activate or deactivate. If the specified time elapses before all relays activate or deactivate, a timeout error is returned. The default value is5000 ms.