WinGetID

Returns the unique ID number of the specified window.

ID := WinGetID(WinTitle, WinText, ExcludeTitle, ExcludeText)

Parameters

WinTitle

Type: String, Integer or Object

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

WinText

Type: String

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

Type: String

Windows whose titles include this value will not be considered.

ExcludeText

Type: String

Windows whose text include this value will not be considered.

Return Value

Type: Integer

This function returns the window handle (HWND) of the specified window. If there is no matching window, an empty string is returned.

Error Handling

An exception is thrown if the window could not be found.

Remarks

This function is equivalent to WinExist.

A window's ID number is valid only during its lifetime. In other words, if an application restarts, all of its windows will get new ID numbers.

The ID of the window under the mouse cursor can be retrieved with MouseGetPos. To discover the HWND of a control (for use with PostMessage, SendMessage or DllCall), use ControlGetHwnd or MouseGetPos.

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

Related

WinGetIDLast, ControlGetHwnd, Hwnd property (Gui object), Win functions, Control functions

Examples

#1: Maximize the active window and report its unique ID:

active_id := WinGetID("A")
WinMaximize active_id
MsgBox "The active window's ID is " active_id