Edit

Share via


IWindowProvider.WaitForInputIdle(Int32) Method

Definition

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

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

Exceptions

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

See also