nf-uiautomationcoreapi-windowpattern_waitforinputidle.md

UID	title	description	helpviewer_keywords	old-location	tech.root	ms.assetid	ms.date	ms.keywords	req.header	req.include-header	req.target-type	req.target-min-winverclnt	req.target-min-winversvr	req.kmdf-ver	req.umdf-ver	req.ddi-compliance	req.unicode-ansi	req.idl	req.max-support	req.namespace	req.assembly	req.type-library	req.lib	req.dll	req.irql	targetos	req.typenames	req.redist	ms.custom	f1_keywords	dev_langs	topic_type	api_type	api_location	api_name
NF:uiautomationcoreapi.WindowPattern_WaitForInputIdle	WindowPattern_WaitForInputIdle function (uiautomationcoreapi.h)	Causes the calling code to block for the specified time or until the associated process enters an idle state, whichever completes first. (WindowPattern_WaitForInputIdle)	WindowPattern_WaitForInputIdle WindowPattern_WaitForInputIdle function [Windows Accessibility] uiauto.uiauto_WindowPattern_WaitForInputIdleConPat uiauto_WindowPattern_WaitForInputIdleConPat uiautomationcoreapi/WindowPattern_WaitForInputIdle winauto.uiauto_WindowPattern_WaitForInputIdleConPat	winauto\uiauto_WindowPattern_WaitForInputIdleConPat.htm	WinAuto	c2a319bd-9698-4671-b3d9-bcfd07c15aef	12/05/2018	WindowPattern_WaitForInputIdle, WindowPattern_WaitForInputIdle function [Windows Accessibility], uiauto.uiauto_WindowPattern_WaitForInputIdleConPat, uiauto_WindowPattern_WaitForInputIdleConPat, uiautomationcoreapi/WindowPattern_WaitForInputIdle, winauto.uiauto_WindowPattern_WaitForInputIdleConPat	uiautomationcoreapi.h		Windows	Windows XP [desktop apps only]	Windows Server 2003 [desktop apps only]										Uiautomationcore.lib	Uiautomationcore.dll		Windows			19H1	WindowPattern_WaitForInputIdle uiautomationcoreapi/WindowPattern_WaitForInputIdle	c++	APIRef kbSyntax	DllExport	Uiautomationcore.dll	WindowPattern_WaitForInputIdle

WindowPattern_WaitForInputIdle function

-description

Note  This function is deprecated. Client applications should use the Microsoft UI Automation Component Object Model (COM) interfaces instead.

 

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

-parameters

-param hobj [in]

Type: HUIAPATTERNOBJECT

The control pattern object.

-param milliseconds [in]

Type: int

The number of milliseconds to wait before retrieving pResult.

-param pResult [out]

Type: BOOL*

TRUE if the window is ready to accept user input; otherwise FALSE.

-returns

Type: HRESULT

Returns S_OK if successful or an error value otherwise.

-remarks

This method is typically used in conjunction with the handling of a WindowOpenedEvent (Window_WindowOpened_Event_GUID). The implementation is dependent on the underlying application framework; therefore this method may 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. Use the value of pResult to determine if the window is ready for input or if the method timed out.