AutoIt Language Reference

[ AutoIt  Batch  KiXtart  VBScript  HTA  PowerShell  Windows Command Lines  Other Command Line Utilities  ]

Functions

Abs - Calculates the absolute value of a number 
ACos - Calculates the arcCosine of a number 
AdlibDisable - Disables the adlib functionality 
AdlibEnable - Enables Adlib functionality 
Asc - Returns the ASCII code of a character 
ASin - Calculates the arcsine of a number 
ATan - Calculates the arctangent of a number 
AutoItSetOption - Changes the behavior of several AutoIt functions/parameters 
AutoItWinGetTitle - Retrieves the title of the AutoIt window 
AutoItWinSetTitle - Changes the title of the AutoIt window 
BitAND - Performs a bitwise AND operation 
BitNOT - Performs a bitwise NOT operation 
BitOR - Performs a bitwise OR operation 
BitShift - Performs a bit shifting operation 
BitXOR - Performs a bitwise exclusive OR (XOR) operation 
BlockInput - Disable/enable the mouse and keyboard 
Break - Enables or disables the users' ability to exit a script from the ... 
Call - Calls a user-defined function contained in a string parameter 
CDTray - Opens or closes the CD tray 
Chr - Returns a character corresponding to an ASCII code 
ClipGet - Retrieves text from the clipboard 
ClipPut - Writes text to the clipboard 
ControlClick - Sends a mouse click command to a given control 
ControlCommand - Sends a command to a control 
ControlDisable - Sends a command to a control 
ControlEnable - Enables a disabled control  
ControlFocus - Sets input focus to a given control on a window 
ControlGetFocus - Returns the control reference number of the control that has keyb... 
ControlGetHandle - Gets the internal handle of a control 
ControlGetPos - Retrieves the position and size of a control relative to it's win... 
ControlGetText - Retrieves text from a control 
ControlHide - Hides a control 
ControlListView - Sends a command to a ListView control 
ControlMove - Moves a control within a window 
ControlSend - Sends a string of characters to a control 
ControlSetText - Sets text of a control 
ControlShow - Shows a control that was hidden 
Cos - Calculates the cosine of a number 
Dec - Returns a numeric representation of a hexadecimal string 
DirCopy - Copies a directory and all sub-directories and files 
DirCreate - Creates a directory 
DirGetSize - Returns the size of a specified directory in bytes 
DirMove - Moves a directory and all sub-directories and files 
DirRemove - Deletes a directory 
DllCall - Dynamically calls a function in a DLL 
DllClose - Closes a previously opened DLL 
DllOpen - Opens a dll file for use in DllCall 
DriveGetDrive - Returns an array containing the enumerated drives 
DriveGetFileSystem - Returns File System Type of a drive 
DriveGetLabel - Returns Volume Label of a drive, if it has one 
DriveGetSerial - Returns Serial Number of a drive 
DriveGetType - Returns drive type 
DriveMapAdd - Maps a network drive 
DriveMapDel - Disconnects a network drive 
DriveMapGet - Retreives the details of a mapped drive 
DriveSetLabel - Sets the Volume Label of a drive 
DriveSpaceFree - Returns the free disk space of a path in Megabytes 
DriveSpaceTotal - Returns the total disk space of a path in Megabytes 
DriveStatus - Returns the status of the drive as a string 
EnvGet - Retrieves an environment variable 
EnvSet - Writes an environment variable 
EnvUpdate - Refreshes the OS environment 
Eval - Return the value of the variable whose name is given by the expre... 
Exp - Calculates e to the power of a number 
FileChangeDir - Changes the current working directory 
FileClose - Closes a text file 
FileCopy - Copies one or more files 
FileCreateShortcut - Creates a shortcut to a file 
FileDelete - Delete one or more files 
FileExists - Checks if a file or directory exists 
FileFindFirstFile - Returns a filename according to search string 
FileFindNextFile - Returns a filename according to search string 
FileGetAttrib - Returns a code string representing a file's attributes 
FileGetLongName - Returns the long path and filename of the path and filename it is... 
FileGetShortcut - Retrieves details about a shortcut 
FileGetShortName - Returns the 8.3 (short) path and filename of the specified path a... 
FileGetSize - Returns the size of a file in bytes 
FileGetTime - Returns the time and date information for a file 
FileGetVersion - Returns the "File" version information 
FileInstall - Include and install a file with the compiled script 
FileMove - Moves one or more files 
FileOpen - Opens a text file for reading or writing 
FileOpenDialog - Initiates a Open File Dialog 
FileRead - Read in a number of characters from a previously opened text file 
FileReadLine - Read in a line of text from a previously opened text file 
FileRecycle - Sends a file or directory to the recycle bin, if possible 
FileRecycleEmpty - Empties the recycle bin 
FileSaveDialog - Initiates a Save File Dialog 
FileSelectFolder - Initiates a Browse For Folder GUI 
FileSetAttrib - Sets the attributes of one or more files 
FileSetTime - Sets the timestamp of one of more files 
FileWrite - Append a line of text to the end of a previously opened text file 
FileWriteLine - Append a line of text to the end of a previously opened text file 
FtpSetProxy - Sets the internet proxy to use for ftp access 
GUICreate - Creates a GUI window 
GUICtrlCreateAVI - Creates an AVI video control for the GUI 
GUICtrlCreateButton - Creates a Button control for the GUI 
GUICtrlCreateCheckbox - Creates a Checkbox control for the GUI 
GUICtrlCreateCombo - Creates a ComboBox control for the GUI 
GUICtrlCreateContextMenu - Creates a context menu for a control or entire GUI window 
GUICtrlCreateDate - Creates a date control for the GUI 
GUICtrlCreateDummy - Creates a Dummy control for the GUI 
GUICtrlCreateEdit - Creates an Edit control for the GUI 
GUICtrlCreateGroup - Creates a Group control for the GUI 
GUICtrlCreateIcon - Creates an Icon control for the GUI 
GUICtrlCreateInput - Creates an Input control for the GUI 
GUICtrlCreateLabel - Creates a static Label control for the GUI 
GUICtrlCreateList - Creates a List control for the GUI 
GUICtrlCreateListView - Creates a ListView control for the GUI 
GUICtrlCreateListViewItem - Creates a ListView item 
GUICtrlCreateMenu - Creates a Menu control for the GUI 
GUICtrlCreateMenuitem - Creates a MenuItem control for the GUI 
GUICtrlCreatePic - Creates a Picture control for the GUI 
GUICtrlCreateProgress - Creates a Progress control for the GUI 
GUICtrlCreateRadio - Creates a Radio button control for the GUI 
GUICtrlCreateSlider - Creates a Slider control for the GUI 
GUICtrlCreateTab - Creates a Tab control for the GUI 
GUICtrlCreateTabItem - Creates a TabItem control for the GUI 
GUICtrlCreateTreeView - Creates a TreeView control for the GUI 
GUICtrlCreateTreeViewItem - Creates a TreeViewItem control for the GUI 
GUICtrlCreateUpdown - Creates an UpDown control for the GUI 
GUICtrlDelete - Deletes a control 
GUICtrlGetState - Gets the current state of a control 
GUICtrlRead - Read state or data of a control 
GUICtrlRecvMsg - Send a message to a control and retrieve information in lParam 
GUICtrlSendMsg - Send a message to a control 
GUICtrlSendToDummy - Sends a message to a Dummy control 
GUICtrlSetBkColor - Sets the background color of a control 
GUICtrlSetColor - Sets the text color of a control 
GUICtrlSetCursor - Sets mouse cursor icon for a particular control 
GUICtrlSetData - Modifies the data for a control 
GUICtrlSetFont - Sets the font for a control 
GUICtrlSetImage - Sets the bitmap or icon image to use for a control 
GUICtrlSetLimit - Limits the number of characters/pixels for a control 
GUICtrlSetOnEvent - Defines a user-defined function to be called when a control is cl... 
GUICtrlSetPos - Changes the position of a control within the GUI window 
GUICtrlSetResizing - Defines the resizing method used by a control 
GUICtrlSetState - Changes the state of a control 
GUICtrlSetStyle - Changes the style of a control 
GUICtrlSetTipf - Sets the tip text associated with a control 
GUIDelete - Deletes a GUI window and all controls that it contains 
GUIGetCursorInfo ([]) - Gets the mouse cursor position relative to GUI window 
GUIGetMsg - Polls the GUI to see if any events have ocurred 
GUISetBkColor - Sets the background color of the GUI window 
GUISetCoord - Sets absolute coordinates for next control 
GUISetCursor - Sets the mouse cursor icon for a GUI window 
GUISetFont - Sets the default font for a GUI window 
GUISetHelp - Sets an executable file that will be run when F1 is pressed 
GUISetIcon - Sets the icon used in a GUI window 
GUISetOnEvent - Defines a user function to be called when a control is clicked 
GUISetState - Changes the state of a GUI window 
GUIStartGroup - Defines that any subsequent controls that are created will be "gr... 
GUISwitch - Switches the current window used for GUI functions. 
Hex - Returns a string representation of an integer converted to hexade... 
HotKeySet - Sets a hotkey that calls a user function 
HttpSetProxy - Sets the internet proxy to use for http access 
InetGet - Downloads a file from the internet using the http or ftp protocol 
InetGetSize - Returns the size of a file located on the Internet in bytes 
IniDelete - Deletes a value from a standard format .ini file 
IniRead - Reads a value from a standard format .ini file 
IniReadSection - Reads all key/value pairs from a section in a standard format .in... 
IniReadSectionNames - Reads all sections in a standard format .ini file 
IniWrite - Writes a value to a standard format .ini file 
InputBox - Displays an input box to ask the user to enter a string 
Int - Returns the integer representation of an expression 
IsAdmin - Checks if the current user has administrator privileges 
IsArray - Checks if a variable is an array type 
IsDeclared - Check if a variable has been declared 
IsFloat - Checks if a variable or expression is a float-type 
IsInt - Checks if a variable or expression is an integer type 
IsNumber - Checks if a variable's base type is numeric 
IsString - Checks if a variable is a string type 
Log - Calculates the natural logarithm of a number 
MemGetStats - Retrieves memory related information 
Mod - Performs the modulus operation 
MouseClick - Perform a mouse click operation 
MouseClickDrag - Perform a mouse click and drag operation 
MouseDown - Perform a mouse down event at the current mouse position 
MouseGetCursor - Returns a cursor ID Number of the current Mouse Cursor 
MouseGetPos - Retrieves the current position of the mouse cursor 
MouseMove - Moves the mouse pointer 
MouseUp - Perform a mouse up event at the current mouse position 
MouseWheel - Moves the mouse wheel up or down 
MsgBox - Displays a simple message box with optional timeout 
Number - Returns the numeric representation of an expression 
Ping - Pings a host and returns the roundtrip-time 
PixelChecksum - Generates a checksum for a region of pixels 
PixelGetColor - Returns a pixel color according to x,y pixel coordinates 
PixelSearch - Searches a rectangle of pixels for the pixel color provided 
ProcessClose - Terminates a named process 
ProcessExists - Checks to see if a specified process exists 
ProcessList - Returns an array listing the currently running processes 
ProcessSetPriority - Changes the priority of a process 
ProcessWait - Pauses script execution until a given process exists 
ProcessWaitClose - Pauses script execution until a given process does not exist 
ProgressOff - Turns Progress window off 
ProgressOn - Creates a customizable progress bar window 
ProgressSet - Sets the position and/or text of a previously created Progress ba... 
Random - Generates a pseudo-random float-type number 
RegDelete - Deletes a key or value from the registry 
RegEnumKey - Reads the name of a subkey according to it's instance 
RegEnumVal - Reads the name of a value according to it's instance 
RegRead - Reads a value from the registry 
RegWrite - Writes a value to the registry 
Round - Returns a number rounded to a specified number of decimal places 
Run - Runs an external program 
RunAsSet - Initialise a set of user credentials to use during Run and RunWai... 
RunWait - Runs an external program and pauses script execution until the pr... 
Send - Sends simulated keystrokes to the active window 
SetError - Manually set the value of the @error macro 
SetExtended - Manually set the value of the @extended macro 
Shutdown - Shuts down the system 
Sin - Calculates the sine of a number 
Sleep - Pause script execution 
SoundPlay - Play a sound file 
SoundSetWaveVolume - Sets the system wave volume by percent 
SplashImageOn - Creates a customizable image popup window 
SplashOff - Turns SplashText or SplashImage off 
SplashTextOn - Creates a customizable text popup window 
Sqrt - Calculates the square-root of a number 
StatusbarGetText - Retrieves the text from a standard status bar control 
String - Returns the string representation of an expression 
StringAddCR - Takes a string and prefixes all linefeed characters ( Chr(10) ) w... 
StringFormat - Returns a formatted string (similar to the C sprintf() function). 
StringInStr - Checks if a string contains a given substring. 
StringIsAlNum - Checks if a string contains only alphanumeric characters 
StringIsAlpha - Checks if a string contains only alphabetic characters 
StringIsASCII - Checks if a string contains only ASCII characters in the range 0x... 
StringIsDigit - Checks if a string contains only digit (0-9) characters 
StringIsFloat - Checks if a string is a floating point number 
StringIsInt - Checks if a string is an integer 
StringIsLower - Checks if a string contains only lowercase characters 
StringIsSpace - Checks if a string contains only whitespace characters 
StringIsUpper - Checks if a string contains only uppercase characters 
StringIsXDigit - Checks if a string contains only hexadecimal digit (0-9, A-F) cha... 
StringLeft - Returns a number of characters from the left-hand side of a strin... 
StringLen - Returns the number of characters in a string 
StringLower - Converts a string to lowercase 
StringMid - Extracts a number of characters from a string 
StringReplace - Replaces substrings in a string 
StringRight - Returns a number of characters from the right-hand side of a stri... 
StringSplit - Splits up a string into substrings depending on the given delimit... 
StringStripCR - Removes all carriage return values from a string 
StringStripWS - Strips the white space in a string 
StringTrimLeft - Trims a number of characters from the left hand side of a string 
StringTrimRight - Trims a number of characters from the right hand side of a string 
StringUpper - Converts a string to uppercase 
Tan - Calculates the tangent of a number 
TimerDiff - Returns a difference in time from a previous call to TimerInit 
TimerInit - Returns a time stamp in milliseconds with accuracy up to 8 decima... 
ToolTip - Creates a tooltip anywhere on the screen 
TrayTip - Displays a balloon tip from the AutoIt Icon 
UBound - Returns the size of array dimensions 
WinActivate - Sets focus to a window 
WinActive - Checks to see if a specified window exists and is currently activ... 
WinClose - Closes a window 
WinExists - Checks to see if a specified window exists 
WinGetCaretPos - Returns the coordinates of the caret in the foreground window 
WinGetClassList - Retrieves the classes from a window 
WinGetClientSize - Retrieves the size of a given window's client area 
WinGetHandle - Retrieves the internal handle of a window 
WinGetPos - Retrieves the position and size of a given window 
WinGetProcess - Retrieves the Process ID (PID) associated with a window 
WinGetState - Retrieves the state of a given window 
WinGetText - Retrieves the text from a window 
WinGetTitle - Retrieves the full title from a window 
WinKill - Forces a window to close 
WinList - Retrieves a list of windows 
WinMenuSelectItem - Invokes a menu item of a window 
WinMinimizeAll - Minimizes all windows 
WinMinimizeAllUndo - Undoes a previous WinMinimizeAll function 
WinMove - Moves and/or resizes a window 
WinSetOnTop - Change a window's "Always On Top" attribute 
WinSetState - Shows, hides, minimizes, maximizes, or restores a window 
WinSetTitle - Changes the title of a window 
WinSetTrans - Sets the transparency of a window 
WinWait - Pauses execution of the script until the requested window exists 
WinWaitActive - Pauses execution of the script until the requested window is acti... 
WinWaitClose - Pauses execution of the script until the requested window does no... 
WinWaitNotActive - Pauses execution of the script until the requested window is not ... 

Keywords

#ce - Identifies the end of comment lines not to be processed 
#comments-end - Identifies the end of comment lines not to be processed 
#comments-start - Identifies the start of comment lines not to be processed 
#cs - Identifies the start of comment lines not to be processed 
#include - Includes the contents of another script in the current script 
#include-once - Keeps a script from being included in another more than one time 
#NoTrayIcon - Indicates that the AutoIt tray icon will not be shown when the sc... 
Case - Specifies a condition to evaluate in a Select statement 
ContinueLoop - Instructs script to continue a loop statement 
Dim - Declare a variable or create an array 
Do - Loop based on an expression 
Else - Identifies the statement to process if the condition being tested... 
ElseIf - Identifies an additional expression to be handled by a conditiona... 
EndFunc - Identifies the end of the code for a user defined function 
EndIf - Marks the end of a If/Else statement 
EndSelect - Marks the end of a conditional Select statement 
Exit - Terminates the script 
ExitLoop - Terminate a While/Do/For loop 
For - Loop based on an expression 
Func - Defines a user-defined function that takes zero or more arguments... 
Global - Creates a variable in the Global scope 
If - Conditionally run a statement 
Local - Creates a variable in the Local/Function scope 
Next - Marks the end of a For loop 
ReDim - Resize an existing array 
Return - Exits a function 
Select - Conditionally run statements 
Then - Identifies statement to run if conditional If statement is not tr... 
Until - Loop based on an expression 
WEnd - Marks the end of a While loop 
While - Loop based on an expression 

Macros

@AppDataCommonDir - Path to Application Data folder 
@AppDataDir - Path to current user's Application Data 
@AutoItVersion - Version number of AutoIt 
@CommonFilesDir - Path to Common Files folder 
@Compiled - Identifies if script is running as a complied executable 
@ComputerName - Computer's network name 
@ComSpec - Path and file name of command interpreter 
@CR - Carriage return 
@CRLF - Carriage return and line feed 
@DesktopCommonDir - Path to Desktop 
@DesktopDepth - Depth of the desktop screen in bits per pixel 
@DesktopDir - Path to current user's Desktop 
@DesktopHeight - Height of screen in pixels 
@DesktopWidth - Width of screen in pixels 
@DocumentsCommonDir - Path to Documents 
@Error - Status of the error flag 
@FavoritesCommonDir - Path to Favorites 
@FavoritesDir - Path to current user's Favorites 
@HomeDrive - Drive letter of drive containing current user's home directory 
@HomePath - Directory part of current user's home directory.  
@HomeShare - Server and share name containing current user's home directory 
@Hour - Hours value of clock in 24-hour format 
@IPAddress1 - IP address of first network adapter 
@IPAddress2 - IP address of second network adapter 
@IPAddress3 - IP address of thrid network adapter 
@IPAddress4 - IP address of fourth network adapter 
@LF - Line feed 
@LogonDNSDomain - Logon DNS Domain 
@LogonDomain - Logon Domain 
@LogonServer - Logon server 
@MDay - Current day of month 
@Min - Minutes value of clock 
@Mon - Current month 
@MyDocumentsDir - Path to My Documents target 
@OSBuild - Returns the OS build number 
@OSLang - Returns code denoting OS Language 
@OSServicePack - Service pack info 
@OSType - Identifies NT or later versions of Windows 
@OSVersion - Version of Windows as text string 
@ProgramFilesDir - Path to Program Files folder 
@ProgramsCommonDir - Path to Start Menu's Programs folder 
@ProgramsDir - Path to current user's Programs (folder on Start Menu) 
@ScriptDir - Directory containing the running script.  
@ScriptFullPath - Full path and name of current script 
@ScriptName - Long filename of the running script 
@Sec - Seconds value of clock 
@StartMenuCommonDir - Path to Start Menu folder 
@StartMenuDir - Path to current user's Start Menu 
@StartupCommonDir - Path to Startup folder 
@StartupDir - Current user's Startup folder 
@SW_Hide - Hide window 
@SW_Maximize - Maximize window 
@SW_Minimize - Minimize window 
@SW_Restore - Undoes a window minimization or maximization 
@SW_Show - Shows a previously hidden window 
@SW_ShowDefault - Sets the show state based on the SW_ value specified by the progr... 
@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.  
@SW_ShowNA - Displays the window in its current size and position 
@SW_ShowNoActivate - Displays a window in its most recent size and position 
@SW_ShowNormal - Activates and displays a window 
@SystemDir - Path to the Windows System (or System32) folder 
@Tab - Tab character 
@TempDir - Path to the temporary files folder 
@UserName - ID of the currently logged on user 
@UserProfileDir - Path to current user's Profile folder 
@WDay - Numeric day of week 
@WindowsDir - Path to Windows folder 
@WorkingDir - Current/active working directory 
@YDay - Current day of year 
@Year - Current four-digit year 

 

iTripoli prides itself on providing top notch customer service

Find answers or open a ticket to ask directly, when opening a ticket we will suggest relavant articles to help you get answers as quickly and accurately as possible. Visit our support center now!

• Review License Info
• Open A Ticket
• Browse Knowledge Base
• Download Files
• Troubleshooter

Please visit our full support center to find answers quickly or submit questions or feedback.