IUIAutomationWindowPattern::WaitForInputIdle method

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

Syntax


HRESULT WaitForInputIdle(
  [in]          int  milliseconds,
  [out, retval] BOOL *success
);

Parameters

milliseconds [in]

Type: int

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

success [out, retval]

Type: BOOL*

Receives the result: TRUE if the window has entered the idle state, or FALSE if the time-out occurred.

Return value

Type: HRESULT

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Requirements

Minimum supported client

Windows 7, Windows Vista with SP2 and Platform Update for Windows Vista, Windows XP with SP3 and Platform Update for Windows Vista [desktop apps only]

Minimum supported server

Windows Server 2008 R2, Windows Server 2008 with SP2 and Platform Update for Windows Server 2008, Windows Server 2003 with SP2 and Platform Update for Windows Server 2008 [desktop apps only]

Header

UIAutomationClient.h (include UIAutomation.h)

IDL

UIAutomationClient.idl

See also

IUIAutomationWindowPattern

 

 

Show: