BuiltInVariables.xml

<BuiltInVariables>
  <Variable name="A_AhkPath" type="String" description="For non-compiled or embedded scripts: The full path and name of the EXE file that is actually running the current script. For compiled scripts based on a .bin file, the value is determined by reading the installation directory from the registry and appending &quot;\AutoHotkey.exe&quot;. If AutoHotkey is not installed, the value is blank. The example below is equivalent:" />
  <Variable name="A_AhkVersion" type="String" description="Contains the version of AutoHotkey that is running the script, such as 1.0.22. In the case of a compiled script, the version that was originally used to compile it is reported. The formatting of the version number allows a script to check whether A_AhkVersion is greater than some minimum version number with &gt; or &gt;= as in this example: if (A_AhkVersion &gt;= &quot;1.0.25.07&quot;). See also: #Requires and VerCompare" />
  <Variable name="A_AllowMainWindow" type="Integer" description="Can be used to get or set whether the script's main window is allowed to be opened via the tray icon. Possible values are 0 (forbidden) and 1 (allowed)." />
  <Variable name="A_AppData" type="String" description="The full path and name of the folder containing the current user's application-specific data. For example:" />
  <Variable name="A_AppDataCommon" type="String" description="The full path and name of the folder containing the all-users application-specific data. For example:" />
  <Variable name="A_Args" type="Array" description="Contains an array of command line parameters. For details, see Passing Command Line Parameters to a Script." />
  <Variable name="A_Clipboard" type="String" description="Can be used to get or set the contents of the OS's clipboard. For details, see A_Clipboard." />
  <Variable name="A_ComputerName" type="String" description="The name of the computer as seen on the network." />
  <Variable name="A_ComSpec" type="String" description="Contains the same string as the ComSpec environment variable, which is usually the full path to the command prompt executable (cmd.exe). Often used with Run/RunWait. For example:" />
  <Variable name="A_ControlDelay" type="Integer" description="Can be used to get or set the delay for control-modifying functions, in milliseconds. For details, see SetControlDelay." />
  <Variable name="A_CoordModeCaret" type="String" description="Can be used to get or set the area to which coordinates are to be relative. Possible values are Screen, Window, and Client. For details, see CoordMode." />
  <Variable name="A_CoordModeMenu" type="String" description="Can be used to get or set the area to which coordinates are to be relative. Possible values are Screen, Window, and Client. For details, see CoordMode." />
  <Variable name="A_CoordModeMouse" type="String" description="Can be used to get or set the area to which coordinates are to be relative. Possible values are Screen, Window, and Client. For details, see CoordMode." />
  <Variable name="A_CoordModePixel" type="String" description="Can be used to get or set the area to which coordinates are to be relative. Possible values are Screen, Window, and Client. For details, see CoordMode." />
  <Variable name="A_CoordModeToolTip" type="String" description="Can be used to get or set the area to which coordinates are to be relative. Possible values are Screen, Window, and Client. For details, see CoordMode." />
  <Variable name="A_Cursor" type="String" description="The type of mouse cursor currently being displayed. It will be one of the following words: AppStarting, Arrow, Cross, Help, IBeam, Icon, No, Size, SizeAll, SizeNESW, SizeNS, SizeNWSE, SizeWE, UpArrow, Wait, Unknown. The acronyms used with the size-type cursors are compass directions, e.g. NESW = NorthEast+SouthWest. The hand-shaped cursors (pointing and grabbing) are classified as Unknown." />
  <Variable name="A_DD" type="String" description="Current 2-digit day of the month (01-31). Synonymous with A_MDay." />
  <Variable name="A_DDD" type="String" description="Current day of the week's abbreviation in the current user's language, e.g. Sun" />
  <Variable name="A_DDDD" type="String" description="Current day of the week's full name in the current user's language, e.g. Sunday" />
  <Variable name="A_DefaultMouseSpeed" type="Integer" description="Can be used to get or set the default mouse speed, an integer from 0 (fastest) to 100 (slowest). For details, see SetDefaultMouseSpeed." />
  <Variable name="A_Desktop" type="String" description="The full path and name of the folder containing the current user's desktop files. For example:" />
  <Variable name="A_DesktopCommon" type="String" description="The full path and name of the folder containing the all-users desktop files. For example:" />
  <Variable name="A_DetectHiddenText" type="Integer" description="Can be used to get or set whether to detect hidden text in a window. Possible values are 0 (disabled) and 1 (enabled). For details, see DetectHiddenText." />
  <Variable name="A_DetectHiddenWindows" type="Integer" description="Can be used to get or set whether to detect hidden windows. Possible values are 0 (disabled) and 1 (enabled). For details, see DetectHiddenWindows." />
  <Variable name="A_EndChar" type="String" description="The ending character that was pressed by the user to trigger the most recent non-auto-replace hotstring. If no ending character was required (due to the * option), this variable will be blank." />
  <Variable name="A_EventInfo" type="Integer" description="Contains additional information about the following events: Mouse wheel hotkeys (WheelDown/Up/Left/Right), OnMessage, Regular Expression Callouts." />
  <Variable name="A_FileEncoding" type="String" description="Can be used to get or set the default encoding for various built-in functions. For details, see FileEncoding." />
  <Variable name="A_HotkeyInterval" type="Integer" description="Can be used to get or set the length of the interval used by A_MaxHotkeysPerInterval, in milliseconds." />
  <Variable name="A_HotkeyModifierTimeout" type="Integer" description="Can be used to get or set the timeout affecting the behavior of Send with hotkey modifiers Ctrl, Alt, Win, and Shift. For details, see A_HotkeyModifierTimeout." />
  <Variable name="A_Hour" type="String" description="Current 2-digit hour (00-23) in 24-hour time (for example, 17 is 5pm). To retrieve 12-hour time as well as an AM/PM indicator, follow this example: FormatTime(, &quot;h:mm:ss tt&quot;)" />
  <Variable name="A_IconFile" type="String" description="Blank unless a custom tray icon has been specified via TraySetIcon -- in which case it is the full path and name of the icon's file." />
  <Variable name="A_IconHidden" type="Integer" description="Can be used to get or set whether to hide the tray icon. Possible values are 0 (visible) and 1 (hidden). For details, see #NoTrayIcon." />
  <Variable name="A_IconNumber" type="Integer" description="Blank if A_IconFile is blank. Otherwise, it's the number of the icon in A_IconFile (typically 1)." />
  <Variable name="A_IconTip" type="String" description="Can be used to get or set the tray icon's tooltip text, which is displayed when the mouse hovers over it. If blank, the script's name is used instead." />
  <Variable name="A_Index" type="Integer" description="Can be used to get or set the number of the current loop iteration (a 64-bit integer). It contains 1 the first time the loop's body is executed. For the second time, it contains 2; and so on. If an inner loop is enclosed by an outer loop, the inner loop takes precedence. A_Index works inside all types of loops, but contains 0 outside of a loop. For counted loops such as Loop, changing A_Index affects the number of iterations that will be performed." />
  <Variable name="A_InitialWorkingDir" type="String" description="The script's initial working directory, which is determined by how it was launched. For example, if it was run via shortcut -- such as on the Start Menu -- its initial working directory is determined by the &quot;Start in&quot; field within the shortcut's properties." />
  <Variable name="A_Is64bitOS" type="Integer" description="Contains 1 (true) if the OS is 64-bit or 0 (false) if it is 32-bit." />
  <Variable name="A_IsAdmin" type="Integer" description="Contains 1 if the current user has admin rights, otherwise 0." />
  <Variable name="A_IsCompiled" type="Integer" description="Contains 1 if the script is running as a compiled EXE and 0 (which is considered false) if it is not." />
  <Variable name="A_IsCritical" type="Integer" description="Contains 0 if Critical is off for the current thread. Otherwise it contains an integer greater than zero, namely the message-check interval being used by Critical. The current state of Critical can be saved and restored via Old_IsCritical := A_IsCritical followed later by A_IsCritical := Old_IsCritical." />
  <Variable name="A_IsPaused" type="Integer" description="Contains 1 if the thread immediately underneath the current thread is paused, otherwise 0." />
  <Variable name="A_IsSuspended" type="Integer" description="Contains 1 if the script is suspended, otherwise 0." />
  <Variable name="A_KeyDelay" type="Integer" description="Can be used to get or set the delay or duration for keystrokes, in milliseconds. For details, see SetKeyDelay." />
  <Variable name="A_KeyDelayPlay" type="Integer" description="Can be used to get or set the delay or duration for keystrokes sent via SendPlay mode, in milliseconds. For details, see SetKeyDelay." />
  <Variable name="A_KeyDuration" type="Integer" description="Can be used to get or set the delay or duration for keystrokes, in milliseconds. For details, see SetKeyDelay." />
  <Variable name="A_KeyDurationPlay" type="Integer" description="Can be used to get or set the delay or duration for keystrokes sent via SendPlay mode, in milliseconds. For details, see SetKeyDelay." />
  <Variable name="A_Language" type="String" description="The system's default language, which is one of these 4-digit codes." />
  <Variable name="A_LastError" type="Integer" description="This is usually the result from the OS's GetLastError() function after the script calls certain functions, including DllCall, Run/RunWait, File/Ini/Reg functions (where documented) and possibly others. A_LastError is a number between 0 and 4294967295 (always formatted as decimal, not hexadecimal). Zero (0) means success, but any other number means the call failed. Each number corresponds to a specific error condition. See OSError for how to get the localized error description text, or search www.microsoft.com for &quot;system error codes&quot; to get a list. A_LastError is a per-thread setting; that is, interruptions by other threads cannot change it." />
  <Variable name="A_LineFile" type="String" description="The full path and name of the file to which A_LineNumber belongs. If the script was loaded from an external file, this is the same as A_ScriptFullPath unless the line belongs to one of the script's #Include files." />
  <Variable name="A_LineNumber" type="Integer" description="The number of the currently executing line within the script (or one of its #Include files). This line number will match the one shown by ListLines; it can be useful for error reporting such as this example: MsgBox &quot;Could not write to log file (line number &quot; A_LineNumber &quot;)&quot;." />
  <Variable name="A_ListLines" type="Integer" description="Can be used to get or set whether to log lines. Possible values are 0 (disabled) and 1 (enabled). For details, see ListLines." />
  <Variable name="A_LoopField" type="String" description="It contains the contents of the current substring (field). If an inner parsing loop is enclosed by an outer parsing loop, the innermost loop's field will take precedence." />
  <Variable name="A_LoopFileAttrib" type="String" description="The attributes of the file currently retrieved." />
  <Variable name="A_LoopFileDir" type="String" description="The path of the directory in which A_LoopFileName resides. If FilePattern contains a relative path rather than an absolute path, the path here will also be relative. A root directory will not contain a trailing backslash. For example: C:" />
  <Variable name="A_LoopFileExt" type="String" description="The file's extension (e.g. TXT, DOC, or EXE). The period (.) is not included." />
  <Variable name="A_LoopFileFullPath" type="String" description="This is different than A_LoopFilePath in the following ways: 1) It always contains the absolute/complete path of the file even if FilePattern contains a relative path; 2) Any short (8.3) folder names in FilePattern itself are converted to their long names; 3) Characters in FilePattern are converted to uppercase or lowercase to match the case stored in the file system. This is useful for converting file names -- such as those passed into a script as command line parameters -- to their exact path names as shown by Explorer." />
  <Variable name="A_LoopFileName" type="String" description="The name of the file or folder currently retrieved (without the path)." />
  <Variable name="A_LoopFilePath" type="String" description="The path and name of the file/folder currently retrieved. If FilePattern contains a relative path rather than an absolute path, the path here will also be relative. In addition, any short (8.3) folder names in FilePattern will still be short (see next item to get the long version)." />
  <Variable name="A_LoopFileShortName" type="String" description="The 8.3 short name or alternate name of the file. If the file doesn't have one (due to the long name being shorter than 8.3 or perhaps because short-name generation is disabled on an NTFS file system), A_LoopFileName will be retrieved instead." />
  <Variable name="A_LoopFileShortPath" type="String" description="The 8.3 short path and name of the file/folder currently retrieved. For example: C:\MYDOCU~1\ADDRES~1.txt. If FilePattern contains a relative path rather than an absolute path, the path here will also be relative." />
  <Variable name="A_LoopFileSize" type="String" description="The size in bytes of the file currently retrieved. Files larger than 4 gigabytes are also supported." />
  <Variable name="A_LoopFileSizeKB" type="String" description="The size in Kbytes of the file currently retrieved, rounded down to the nearest integer." />
  <Variable name="A_LoopFileSizeMB" type="String" description="The size in Mbytes of the file currently retrieved, rounded down to the nearest integer." />
  <Variable name="A_LoopFileTimeAccessed" type="String" description="The time the file was last accessed. Format YYYYMMDDHH24MISS." />
  <Variable name="A_LoopFileTimeCreated" type="String" description="The time the file was created. Format YYYYMMDDHH24MISS." />
  <Variable name="A_LoopFileTimeModified" type="String" description="The time the file was last modified. Format YYYYMMDDHH24MISS." />
  <Variable name="A_LoopReadLine" type="String" description="It contains the contents of the current line excluding the carriage return and linefeed (`r`n) that marks the end of the line." />
  <Variable name="A_LoopRegKey" type="String" description="full name of the key which contains the current loop item. For remote registry access, this value will not include the computer name." />
  <Variable name="A_LoopRegName" type="String" description="of the currently retrieved item, which can be either a value name or the name of a subkey. Value names displayed by Windows RegEdit as &quot;(Default)&quot; will be retrieved if a value has been assigned to them, but A_LoopRegName will be blank for them." />
  <Variable name="A_LoopRegTimeModified" type="String" description="time the current subkey or any of its values was last modified. Format YYYYMMDDHH24MISS. This variable will be empty if the currently retrieved item is not a subkey (i.e. A_LoopRegType is not the word KEY)." />
  <Variable name="A_LoopRegType" type="String" description="type of the currently retrieved item, which is one of the following words: KEY (i.e. the currently retrieved item is a subkey not a value), REG_SZ, REG_EXPAND_SZ, REG_MULTI_SZ, REG_DWORD, REG_QWORD, REG_BINARY, REG_LINK, REG_RESOURCE_LIST, REG_FULL_RESOURCE_DESCRIPTOR, REG_RESOURCE_REQUIREMENTS_LIST, REG_DWORD_BIG_ENDIAN (probably rare on most Windows hardware). It will be empty if the currently retrieved item is of an unknown type." />
  <Variable name="A_MaxHotkeysPerInterval" type="Integer" description="Can be used to get or set the maximum number of hotkeys that can be pressed within the interval defined by A_HotkeyInterval without triggering a warning dialog. For details, see A_MaxHotkeysPerInterval." />
  <Variable name="A_MenuMaskKey" type="String" description="Controls which key is used to mask Win or Alt keyup events. For details, see A_MenuMaskKey." />
  <Variable name="A_Min" type="String" description="Current 2-digit minute (00-59)." />
  <Variable name="A_MM" type="String" description="Current 2-digit month (01-12). Synonymous with A_Mon." />
  <Variable name="A_MMM" type="String" description="Current month's abbreviation in the current user's language, e.g. Jul" />
  <Variable name="A_MMMM" type="String" description="Current month's full name in the current user's language, e.g. July" />
  <Variable name="A_MouseDelay" type="Integer" description="Can be used to get or set the mouse delay, in milliseconds. A_MouseDelay is for the traditional SendEvent mode, whereas A_MouseDelayPlay is for SendPlay. For details, see SetMouseDelay." />
  <Variable name="A_MouseDelayPlay" type="Integer" description="Can be used to get or set the mouse delay, in milliseconds. A_MouseDelay is for the traditional SendEvent mode, whereas A_MouseDelayPlay is for SendPlay. For details, see SetMouseDelay." />
  <Variable name="A_MSec" type="String" description="Current 3-digit millisecond (000-999). To remove the leading zeros, follow this example: Milliseconds := A_MSec + 0." />
  <Variable name="A_MyDocuments" type="String" description="The full path and name of the current user's &quot;My Documents&quot; folder. Unlike most of the similar variables, if the folder is the root of a drive, the final backslash is not included (e.g. it would contain M: rather than M:\). For example:" />
  <Variable name="A_Now" type="String" description="The current local time in YYYYMMDDHH24MISS format." />
  <Variable name="A_NowUTC" type="String" description="The current Coordinated Universal Time (UTC) in YYYYMMDDHH24MISS format. UTC is essentially the same as Greenwich Mean Time (GMT)." />
  <Variable name="A_OSVersion" type="String" description="The version number of the operating system, in the format &quot;major.minor.build&quot;. For example, Windows 7 SP1 is 6.1.7601." />
  <Variable name="A_PriorHotkey" type="String" description="Same as above except for the previous hotkey. It will be blank if none." />
  <Variable name="A_PriorKey" type="String" description="The name of the last key which was pressed prior to the most recent key-press or key-release, or blank if no applicable key-press can be found in the key history. All input generated by AutoHotkey scripts is excluded. For this variable to be of use, the keyboard or mouse hook must be installed and key history must be enabled." />
  <Variable name="A_ProgramFiles" type="String" description="The Program Files directory (e.g. C:\Program Files or C:\Program Files (x86)). This is usually the same as the ProgramFiles environment variable." />
  <Variable name="A_Programs" type="String" description="The full path and name of the Programs folder in the current user's Start Menu. For example:" />
  <Variable name="A_ProgramsCommon" type="String" description="The full path and name of the Programs folder in the all-users Start Menu. For example:" />
  <Variable name="A_PtrSize" type="Integer" description="Contains the size of a pointer, in bytes. This is either 4 (32-bit) or 8 (64-bit), depending on what type of executable (EXE) is running the script." />
  <Variable name="A_RegView" type="String" description="Can be used to get or set the registry view. Possible values are 32, 64 and Default. For details, see SetRegView." />
  <Variable name="A_ScreenDPI" type="Integer" description="Number of pixels per logical inch along the screen width. In a system with multiple display monitors, this value is the same for all monitors. On most systems this is 96; it depends on the system's text size (DPI) setting. See also the GUI's -DPIScale option." />
  <Variable name="A_ScreenHeight" type="Integer" description="The height of the primary monitor, in pixels." />
  <Variable name="A_ScreenWidth" type="Integer" description="The width of the primary monitor, in pixels." />
  <Variable name="A_ScriptDir" type="String" description="The full path of the directory where the current script is located. The final backslash is omitted (even for root directories)." />
  <Variable name="A_ScriptFullPath" type="String" description="The full path of the current script, e.g. C:\Scripts\My Script.ahk" />
  <Variable name="A_ScriptHwnd" type="Integer" description="The unique ID (HWND/handle) of the script's hidden main window." />
  <Variable name="A_ScriptName" type="String" description="Can be used to get or set the default title for MsgBox, InputBox, FileSelect, DirSelect and Gui. If not set by the script, it defaults to the file name of the current script, without its path, e.g. MyScript.ahk." />
  <Variable name="A_Sec" type="String" description="Current 2-digit second (00-59)." />
  <Variable name="A_SendLevel" type="Integer" description="Can be used to get or set the send level, an integer from 0 to 100. For details, see SendLevel." />
  <Variable name="A_SendMode" type="String" description="Can be used to get or set the send mode. Possible values are Event, Input, Play, and InputThenPlay. For details, see SendMode." />
  <Variable name="A_Space" type="String" description="Contains a single space character." />
  <Variable name="A_StartMenu" type="String" description="The full path and name of the current user's Start Menu folder. For example:" />
  <Variable name="A_StartMenuCommon" type="String" description="The full path and name of the all-users Start Menu folder. For example:" />
  <Variable name="A_Startup" type="String" description="The full path and name of the Startup folder in the current user's Start Menu. For example:" />
  <Variable name="A_StartupCommon" type="String" description="The full path and name of the Startup folder in the all-users Start Menu. For example:" />
  <Variable name="A_StoreCapsLockMode" type="Integer" description="Can be used to get or set whether to restore the state of CapsLock after a Send. Possible values are 0 (disabled) and 1 (enabled). For details, see SetStoreCapsLockMode." />
  <Variable name="A_Tab" type="String" description="Contains a single tab character." />
  <Variable name="A_Temp" type="String" description="The full path and name of the folder designated to hold temporary files. It is retrieved from one of the following locations (in order): 1) the environment variables TMP, TEMP, or USERPROFILE; 2) the Windows directory. For example:" />
  <Variable name="A_ThisFunc" type="String" description="The name of the user-defined function that is currently executing (blank if none); for example: MyFunction. See also: Name property (Func)" />
  <Variable name="A_ThisHotkey" type="String" description="The most recently executed hotkey or non-auto-replace hotstring (blank if none), e.g. #z. This value will change if the current thread is interrupted by another hotkey or hotstring, so it is generally better to use the parameter ThisHotkey when available." />
  <Variable name="A_TickCount" type="Integer" description="The number of milliseconds that have elapsed since the system was started, up to 49.7 days. By storing A_TickCount in a variable, elapsed time can later be measured by subtracting that variable from the latest A_TickCount value. For example:" />
  <Variable name="A_TimeIdle" type="Integer" description="The number of milliseconds that have elapsed since the system last received keyboard, mouse, or other input. This is useful for determining whether the user is away. Physical input from the user as well as artificial input generated by any program or script (such as the Send or MouseMove functions) will reset this value back to zero. Since this value tends to increase by increments of 10, do not check whether it is equal to another value. Instead, check whether it is greater or less than another value. For example:" />
  <Variable name="A_TimeIdleKeyboard" type="Integer" description="If the keyboard hook is installed, this is the number of milliseconds that have elapsed since the system last received physical keyboard input. Otherwise, this variable is equivalent to A_TimeIdle." />
  <Variable name="A_TimeIdleMouse" type="Integer" description="If the mouse hook is installed, this is the number of milliseconds that have elapsed since the system last received physical mouse input. Otherwise, this variable is equivalent to A_TimeIdle." />
  <Variable name="A_TimeIdlePhysical" type="Integer" description="Similar to above but ignores artificial keystrokes and/or mouse clicks whenever the corresponding hook (keyboard or mouse) is installed; that is, it responds only to physical events. (This prevents simulated keystrokes and mouse clicks from falsely indicating that a user is present.) If neither hook is installed, this variable is equivalent to A_TimeIdle. If only one hook is installed, only its type of physical input affects A_TimeIdlePhysical (the other/non-installed hook's input, both physical and artificial, has no effect)." />
  <Variable name="A_TimeSincePriorHotkey" type="String" description="The number of milliseconds that have elapsed since A_PriorHotkey was pressed. It will be blank whenever A_PriorHotkey is blank." />
  <Variable name="A_TimeSinceThisHotkey" type="String" description="The number of milliseconds that have elapsed since A_ThisHotkey was pressed. It will be blank whenever A_ThisHotkey is blank." />
  <Variable name="A_TitleMatchMode" type="Integer" description="Can be used to get or set the title match mode. Possible values are 1, 2, 3, and RegEx. For details, see SetTitleMatchMode." />
  <Variable name="A_TitleMatchModeSpeed" type="String" description="Can be used to get or set the title match speed. Possible values are Fast and Slow. For details, see SetTitleMatchMode." />
  <Variable name="A_TrayMenu" type="Menu" description="Returns a Menu object which can be used to modify or display the tray menu." />
  <Variable name="A_UserName" type="String" description="The logon name of the user who launched this script." />
  <Variable name="A_WDay" type="String" description="Current 1-digit day of the week (1-7). 1 is Sunday in all locales." />
  <Variable name="A_WinDelay" type="Integer" description="Can be used to get or set the delay for windowing functions, in milliseconds. For details, see SetWinDelay." />
  <Variable name="A_WinDir" type="String" description="The Windows directory. For example: C:\Windows" />
  <Variable name="A_WorkingDir" type="String" description="Can be used to get or set the script's current working directory, which is where files will be accessed by default. The final backslash is not included unless it is the root directory. Two examples: C:\ and C:\My Documents." />
  <Variable name="A_YDay" type="String" description="Current day of the year (1-366). The value is not zero-padded, e.g. 9 is retrieved, not 009. To retrieve a zero-padded value, use the following: FormatTime(, &quot;YDay0&quot;)." />
  <Variable name="A_YWeek" type="String" description="Current year and week number (e.g. 200453) according to ISO 8601. To separate the year from the week, use Year := SubStr(A_YWeek, 1, 4) and Week := SubStr(A_YWeek, -2). Precise definition of A_YWeek: If the week containing January 1st has four or more days in the new year, it is considered week 1. Otherwise, it is the last week of the previous year, and the next week is week 1." />
  <Variable name="A_YYYY" type="String" description="Current 4-digit year (e.g. 2004). Synonymous with A_Year." />
  <Variable name="False" type="Integer" description="Contain 0. Can be used to make a script more readable. For details, see Boolean Values." />
  <Variable name="True" type="Integer" description="Contain 1. Can be used to make a script more readable. For details, see Boolean Values." />
</BuiltInVariables>