Macro Reference - AutoIt Related

Below is a list of AutoIt-related macros.

The full list of macros can be found here.

 

Macro Description
@Compiled Returns 1 if script is a compiled executable or an .a3x file; returns 0 if an .au3 file.
@error Status of the error flag. See the function SetError().
@exitCode Exit code as set by Exit statement.
@exitMethod Exit method. See the function OnAutoItExitRegister().
@extended Extended function return - used in certain functions such as StringReplace().
@NumParams Number of parameters used in calling the user function.
@ScriptName Filename of the running script.
@ScriptDir Directory containing the running script. Only includes a trailing backslash when the script is located in the root of a drive.
@ScriptFullPath Equivalent to @ScriptDir & "\" & @ScriptName
@ScriptLineNumber Line number being executed - useful for debug statements (e.g. location of function call). Only significant in uncompiled scripts - note that #include files return their internal line numbering
@WorkingDir Current/active working directory. Only includes a trailing backslash when the script is located in the root of a drive.
@AutoItExe The full path and filename of the AutoIt executable currently running. For compiled scripts it is the path of the compiled script; for .a3x and .au3 files it is the path of the interpreter running the file.
@AutoItPID Process identifier (PID) of the current script.
@AutoItVersion Version number of AutoIt such as 3.3.10.2
@AutoItX64 Returns 1 if the script is running under the native x64 version of AutoIt.

@COM_EventObj Object the COM event is being fired on. Only valid in a COM event function.
@GUI_CtrlId Last click GUI Control identifier. Only valid in an event Function. See the GUICtrlSetOnEvent() function.
@GUI_CtrlHandle Last click GUI Control handle. Only valid in an event Function. See the GUICtrlSetOnEvent() function.
@GUI_DragId Drag GUI Control identifier. Only valid on Drop Event. See the GUISetOnEvent() function.
@GUI_DragFile Filename of the file being dropped. Only valid on Drop Event. See the GUISetOnEvent() function.
@GUI_DropId Drop GUI Control identifier. Only valid on Drop Event. See the GUISetOnEvent() function.
@GUI_WinHandle Last click GUI window handle. Only valid in an event Function. See the GUICtrlSetOnEvent() function.
@HotKeyPressed Last hotkey pressed. See the HotKeySet() function.

For use with the WinSetState(), Run(), RunWait, FileCreateShortcut() and FileGetShortcut() functions:
@SW_DISABLE Disables the window.
@SW_ENABLE Enables the window.
@SW_HIDE Hides the window and activates another window.
@SW_LOCK Lock the window to avoid repainting.
@SW_MAXIMIZE Activates the window and displays it as a maximized window.
@SW_MINIMIZE Minimizes the specified window and activates the next top-level window in the Z order.
@SW_RESTORE Activates and displays the window. If the window is minimized or maximized, the system restores it to its original size and position. An application should specify this flag when restoring a minimized window.
@SW_SHOW Activates the window and displays it in its current size and position.
@SW_SHOWDEFAULT Sets the show state based on the SW_ value specified by the program that started the application.
@SW_SHOWMAXIMIZED Activates the window and displays it as a maximized window.
@SW_SHOWMINIMIZED Activates the window and displays it as a minimized window.
@SW_SHOWMINNOACTIVE Displays the window as a minimized window. This value is similar to @SW_SHOWMINIMIZED, except the window is not activated.
@SW_SHOWNA Displays the window in its current size and position. This value is similar to @SW_SHOW, except the window is not activated.
@SW_SHOWNOACTIVATE Displays a window in its most recent size and position. This value is similar to @SW_SHOWNORMAL, except the window is not activated.
@SW_SHOWNORMAL Activates and displays a window. If the window is minimized or maximized, the system restores it to its original size and position. An application should specify this flag when displaying the window for the first time.
@SW_UNLOCK Unlock window to allow painting.

@TRAY_ID Last clicked item identifier during a TraySetOnEvent() or TrayItemSetOnEvent() action.
@TrayIconFlashing Returns 1 if tray icon is flashing; otherwise, returns 0.
@TrayIconVisible Returns 1 if tray icon is visible; otherwise, returns 0.

@CR Carriage return, Chr(13); occasionally used for line breaks.
@LF Line feed, Chr(10); occasionally used for line breaks.
@CRLF @CR & @LF; typically used for line breaks.
@TAB Tab character, Chr(9)