WinActive() / IfWin[Not]Active

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

WinActive()

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

Parameters

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

This function returns the Unique ID (HWND) (as hexadecimal integer) of the active window if it matches the specified criteria. If it does not, the function returns 0. Since all non-zero numbers are seen as "true", the statement if WinActive(WinTitle) is true whenever WinTitle is active.

Examples

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.

IfWin[Not]Active

Deprecated: This command is not recommended for use in new scripts. Use the WinActive function instead.

IfWinActive , WinTitle, WinText, ExcludeTitle, ExcludeText
IfWinNotActive , WinTitle, WinText, ExcludeTitle, ExcludeText

Parameters

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.

Note: Due to backward compatibility, IfWin[Not]Active interpret this parameter as a command if it exactly matches the name of a command. To work around this, use the WinActive function instead.

ExcludeText

Windows whose text include this value will not be considered.

Remarks

SetWinDelay does not apply to this command.

Examples

IfWinActive, Untitled - Notepad
{
    WinMaximize  ; Maximizes the Notepad window found by IfWinActive above.
    Send, Some text.{Enter}
    return
}

Remarks

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

If the function or command determines that the active window is a qualified match, the Last Found Window will be updated to be the active window. In other words, if WinActive or IfWinActive evaluates to true or IfWinNotActive evaluates to false, the Last Found Window will be updated.

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

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