Function WinGetState

  • WinGetState(windowTitle: string, windowText?: string): WindowState

    Returns the state of a window.

    Though the original AutoIt function returns a bitmask, this function returns an object with boolean properties for each state for ease of use.

    Parameters

    • windowTitle: string

      The title of the window to check.

    • windowText: string = ''

      Optional text found in the window.

    Returns WindowState

    An object containing the state of the window.

    Example

    import { WinGetState } from '@ahmic/autoit-js';

    const state = WinGetState('Untitled - Notepad');

    console.log(state.exists); // true if the window exists
    console.log(state.visible); // true if the window is visible

    See

    https://www.autoitscript.com/autoit3/docs/func/WinGetState.htm

Settings

Member Visibility