Core Function WinWait

From Sputnik Wiki
(Difference between revisions)
Jump to: navigation, search
(Created page with "<pre> WinWait ( <title>, <text>, <timeout> ) </pre> === Description === Waits until the requested window exists. === Parameters === ==== Title ==== The title of the window. ...")
 
m (1 revision)
 
(4 intermediate revisions by one user not shown)
Line 23: Line 23:
 
=== Return Value ===
 
=== Return Value ===
  
None.
+
Success: Returns 1.
  
=== Remarks ===
+
Failure: Returns 0 if timeout occurred.
  
The difference between this function and WinClose is that WinKill will forcibly terminate the window if it doesn't close quickly enough. Consequently, a user might not have time to respond to dialogs prompting the user to save data.
+
=== Remarks ===
  
Although WinKill can work on both minimized and hidden windows, some windows (notably Windows Explorer) can only be terminated using WinClose.
+
The window is polled every 250 milliseconds or so.
  
 
See "WinTitleMatchMode" in [[Core Function Opt|Opt]].
 
See "WinTitleMatchMode" in [[Core Function Opt|Opt]].

Latest revision as of 12:38, 14 June 2015

WinWait ( <title>, <text>, <timeout> )

Contents

Description

Waits until the requested window exists.

Parameters

Title

The title of the window.

Text

Optional; The text of the window to read.

Timeout

Optional; Timeout in seconds.

Return Value

Success: Returns 1.

Failure: Returns 0 if timeout occurred.

Remarks

The window is polled every 250 milliseconds or so.

See "WinTitleMatchMode" in Opt.

Example

// Wait for the window "Untitled" to exist
Run("notepad");
WinWait("Untitled");
 
// Wait a maximum of 5 seconds for "Untitled" to exist
WinWait("Untitled", "", 5);
Personal tools
Namespaces
Variants
Actions
Navigation
Toolbox