WindowPattern_WaitForInputIdle
TOC
Collapse the table of content
Expand the table of content

WindowPattern_WaitForInputIdle function

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.

Syntax


HRESULT WindowPattern_WaitForInputIdle(
  _In_  HUIAPATTERNOBJECT hobj,
  _In_  int               milliseconds,
  _Out_ BOOL              *pResult
);

Parameters

hobj [in]

Type: HUIAPATTERNOBJECT

The control pattern object.

milliseconds [in]

Type: int

The number of milliseconds to wait before retrieving pResult.

pResult [out]

Type: BOOL*

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

Return value

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.

Requirements

Minimum supported client

Windows XP [desktop apps only]

Minimum supported server

Windows Server 2003 [desktop apps only]

Header

UIAutomationCoreApi.h

Library

Uiautomationcore.lib

DLL

Uiautomationcore.dll

 

 

Show:
© 2016 Microsoft