WinActive

Checks if the specified window exists and is currently active (foremost). If it is, WinActive() returns its Unique ID (HWND).

OutputVar := WinActive(WinTitle, WinText, ExcludeTitle, ExcludeText)

Function Example: id := WinActive("A")

Parameters

OutputVar

The name of the variable in which to store the retrieved UniqueID.

WinTitle

A window title or other criteria identifying the target window. See WinTitle.

WinText

If present, this parameter must be a substring from a single text element of the target window (as revealed by the included Window Spy utility). Hidden text elements are detected if DetectHiddenText is ON.

ExcludeTitle

Windows whose titles include this value will not be considered.

ExcludeText

Windows whose text include this value will not be considered.

Return Value

Returns the Unique ID (HWND) of the active window if it matches the specified criteria, or 0 if it does not.

Since all non-zero numbers are seen as "true", the statement if WinActive("WinTitle") is true whenever WinTitle is active.

Remarks

If all parameters are omitted, the Last Found Window will be used.

If the active window is a qualified match, the Last Found Window will be updated to be the active window.

An easy way to retrieve the unique ID of the active window is with ActiveHwnd := WinExist("A").

Window titles and text are case sensitive. Hidden windows are not detected unless DetectHiddenWindows has been turned on.

Related

WinExist, SetTitleMatchMode, DetectHiddenWindows, Last Found Window, WinActivate, WinWaitActive, WinWait, WinWaitClose, #IfWinActive/Exist

Example

If WinActive("Untitled - Notepad")
{
    WinMaximize  ; Maximizes the Notepad window found by WinActive above.
    Send, Some text.{Enter}
    return
}

if WinActive("ahk_class Notepad") or WinActive("ahk_class" . ClassName)  ; "ahk_class" need not have a space after it.
    WinClose  ; Uses the last found window.