IWindowProvider.WaitForInputIdle(Int32) Method

Reference

Definition

Namespace:: System.Windows.Automation.Provider

Assembly:: UIAutomationProvider.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Causes the calling code to block for the specified time or until the associated process enters an idle state, whichever completes first.

public:
 bool WaitForInputIdle(int milliseconds);

public bool WaitForInputIdle (int milliseconds);

abstract member WaitForInputIdle : int -> bool

Public Function WaitForInputIdle (milliseconds As Integer) As Boolean

Parameters

milliseconds: Int32

The amount of time, in milliseconds, to wait for the associated process to become idle. The maximum is Int32.MaxValue.

Returns

Boolean

true if the window has entered the idle state; false if the timeout occurred.

Exceptions

ArgumentOutOfRangeException

When the parameter passed in is not a valid number.

Remarks

This method is typically used in conjunction with the handling of a WindowOpenedEvent.

The implementation is dependent on the underlying application framework; therefore this method might return some time after the window is ready for user input. The calling code should not rely on this method to ascertain exactly when the window has become idle.

Applies to