AutoIt Wiki - User contributions [en]

Best coding practices

2015-03-07T07:11:35Z

Jaberwocky6669: /* Magic Numbers */ Expanded the first example in Magic Numbers to include an example of correct usage.

Outlined in this section is a detailed explanation of what is to be considered the best coding practices within AutoIt.

A few notes:
* You must use the latest version of AutoIt (v3.3.10.0 or above) to run the examples below.

__TOC__

== Names of Variables ==
A variant of [http://en.wikipedia.org/wiki/Hungarian_notation Hungarian notation] is used.<br />
In AutoIt the Hungarian notation defines the logical data type rather than the physical data type; in this way, it gives a hint as to what the variable's purpose is, or what it represents. The prefix does not encode the actual data type: this occurs on assignment.<br />
See the table below for examples.

{| class="wikitable"
|-
! prefix !! covering type !! example
|-
| i || Integer || $iInteger = 10
|-
| f || Floating point || $fFloat = 0.123
|-
| n || General number (no preference) || $nNumber = 123
|-
| a || Arrays || Local $aArray[0]
|-
| m || Maps || Local $mMap[]
|-
| s || Strings (chars included) || $sString = "hello world"
|-
| b || Booleans || $bBool = True
|-
| d || Binaries || $dBinary = Binary("0x80000000")
|-
| id || An AutoIt controlid || $idButton = GUICtrlCreateButton("OK", 5, 5)
|-
| h || Handles (and GUI handles) || $hGUI = GUICreate("My GUI")
|-
| fu || Functions || $fuMessage = MsgBox
|-
| p || Pointers || $p = 0
|-
| tag || Structures definition || $tag = 0
|-
| t || Structures || $t = 0
|-
| o || Objects || $o = 0 or $o = Null
|-
| v || Variant || $v = 0 or $v = "" (or $v = Null)
|-
| e || Enumerations || Enum $e1st = 1, $e2nd, $e3rd
|-
| k || Keywords || $kKeyword = Default
|}

The variables are named following this schema:
{| class="wikitable"
|-
! type (lower case) !! [optional] subtype (lower case) !! var name (first letter in upper case)
|-
| i || f || MyFlag
|}

Example:
<syntaxhighlight lang="autoit">
; Assign a Local variable the number 5.
Local $iSomeVar = 5

; Assign a Local variable the number 1.
Local $ifMyFlag = 1

; Assign a Local variable an array of numbers.
Local $aiArray = 0

; Re-declare the array to size and fill it.
Local $aiArray[3] = [0, 0.25, 3 / 4]
</syntaxhighlight>

Always initialize a variable on it's declaration, and declare all the same type of variable on the same line.

Example:
<syntaxhighlight lang="autoit">
;Bad
Local $iSomeVar1, $aiArray = 0
Local $iSomeVar2 = 5

;Good
Local $iSomeVar1 = 0, $iSomeVar2 = 5
Local $aiArray = 0
</syntaxhighlight>
You can still categorize your variables and declare for example the $iSomeVar2 on another line.

Example2:
<syntaxhighlight lang="autoit">
#include <MsgBoxConstants.au3>

Local $vValue ; Bad, this is initially blank.
Local $vVal = 0 ; Good

MsgBox($MB_SYSTEMMODAL, '', '$vValue: ' & $vValue & @CRLF & '$vVal: ' & $vVal)

; In C++ $vValue would display the previous value that was residing in the memory address $vValue points to. AutoIt
; is a little less forgiving in that it initialises the variable as being blank and doesn't throw any error, unlike some moder C++ compilers.
</syntaxhighlight>

== Scopes of Variables ==
To make the transition, the variables are also named according to their scope.
{| class="wikitable"
|-
! Global UDF variable !! Global variable !! Local variable
|-
| $g__iSomeVar || $g_iSomeVar || $iSomeVar
|}
With this method, you will avoid non wanted re-assignments.

Example:
<syntaxhighlight lang="autoit">
#include <MsgBoxConstants.au3>

; Assign a Global variable the number 0.
Global $iSomeVar1 = 0
; Assign a Global variable the number 5.
Global $_iSomeVar2 = 5

SomeFunc()

Func SomeFunc()
; Assign Local variables respectively the numbers 3 and 4.
Local $iSomeVar1 = 3, $iSomeVar2 = 4

; Note: The user inadvertently re-assigned the global variable $iSomeVar1, because this one is not named as "global".

; Display the value of $iSomeVar1.
MsgBox($MB_SYSTEMMODAL, "", "Value of $iSomeVar1: " & $iSomeVar1)

; Display the value of $iSomeVar2.
MsgBox($MB_SYSTEMMODAL, "", "Value of $iSomeVar2: " & $iSomeVar2)

; Display the value of $_iSomeVar2.
MsgBox($MB_SYSTEMMODAL, "", "Value of $_iSomeVar2: " & $_iSomeVar2)
EndFunc
</syntaxhighlight>

* A variable declared globally (with the Global keyword) is visible anywhere in the script.
Always declare your global variables in the global scope, not in the functions. It will prevent another function to use it before its declaration and the declaration is implicit (see [[#jumpsec1|examples]]).

* A variable declared locally (with the Local keyword), has a visibility which depends of the scope where it's declared.
:Declaration in the global scope: the variable is nonetheless visible everywhere; declare it as Local if this one is only used in the same scope.
:Declaration in a function: the variable is visible by the function itself and nowhere else.

Structure of a code scope:
<syntaxhighlight lang="autoit">
; Global scope.

; Include the Constants file, it contains various constants; it's needed here for the $MB_SYSTEMMODAL flag of the MsgBox function).
#include <MsgBoxConstants.au3>

; This scope is either Global or Local, depending on where do you use the variables.

; Assign a Global variable the number 0 (which corresponds to an initialization of a variable number), its scope is Global because it's used at least in one function.
Global $_iVar1 = 0

; Assign a Local variable the string "foo", its scope is Local because it's use is restricted to this scope.
Local $_sVar2 = "foo"

; Display the content of $_sVar2
MsgBox($MB_SYSTEMMODAL, "", "Value of $sVar2: " & $_sVar2)

; Re-assign a Local variable the string returned by the function MyFunc.
$_sVar2 = MyFunc()

; Re-Display the content of $_sVar2
MsgBox($MB_SYSTEMMODAL, "", "Value of $sVar2: " & $_sVar2)

; Declare a function (its main utility is described later in Functions, we can see one here which is to create a Local scope).
Func MyFunc()
; Local scope.

; Display the content of $_iVar1.
MsgBox($MB_SYSTEMMODAL, "", "Value of $_iVar1: " & $_iVar1)

; Assign a Local variable the string "bar", its scope is Local because it's use is restricted to the function's scope.
Local $sVar3 = "bar"

; Display the content of $sVar3.
MsgBox($MB_SYSTEMMODAL, "", "Value of $sVar3: " & $sVar3)

; Return the $sVar3 content, it will be visible (if used) to the scope where the function is called.
Return $sVar3
EndFunc ;==>MyFunc
</syntaxhighlight>

Concerning the Dim keyword, its recommended usage is limited to empty an existing array (Example 1) or to redeclare a function parameter (Example 2).

Example 1:
<syntaxhighlight lang="autoit">
; Include the Array UDF, it's needed here for the _ArrayDisplay function.
#include <Array.au3>

; Assign a Local variable an array containing numbers with a size of 5.
; Note than an array is based 0 index, to access the first element the code is: $aiArray[0].
Local $aArray[5] = [1, 2, 3, 4, 5]

; Display the contents.
_ArrayDisplay($aArray)

; Empty the array (and keep its size).
Dim $aArray[5]

; Display the contents.
_ArrayDisplay($aArray)
</syntaxhighlight>
Remark: The variable type of the emptied array is a string, every variable non initialized is a string.

Example 2:
<syntaxhighlight lang="autoit">
#include <Array.au3>

; Call MyFunc with default parameters ($vParam1 = 0).
MyFunc()

; Assign a Local variable an array containing integers.
Local $aiArray[3] = [3, 4, 5]
; Call MyFunc with $aiArray as parameter ($vParam1 = $aiArray).
MyFunc($aiArray)

Func MyFunc($vParam1 = 0)
; If $vParam1 is NOT an array then redeclare it to an array.
If IsArray($vParam1) = 0 Then
Dim $vParam1[3] = [0, 1, 2]
EndIf

; Display the array.
_ArrayDisplay($vParam1)
EndFunc ;==>MyFunc
</syntaxhighlight>

And for the ReDim keyword, limit its use to resize an array you want to keep its content:
<syntaxhighlight lang="autoit">
; Include the Array UDF, it's needed here for the _ArrayDisplay function.
#include <Array.au3>

; Assign a Local variable an array containing numbers with a size of 5.
; Note than an array is based 0 index, to access the first element the code is: $aiArray[0].
Local $aArray[5] = [1, 2, 3, 4, 5]

; Display the contents.
_ArrayDisplay($aArray)

; Resize the array (and keep its content).
ReDim $aArray[3]

; Display the contents.
_ArrayDisplay($aArray)
</syntaxhighlight>

Why using Dim over Local/Global is not always a good option:
<syntaxhighlight lang="autoit">
#include <MsgBoxConstants.au3>

Dim $vVariableThatIsGlobal = "This is a variable that has ""Program Scope"" aka Global."

MsgBox($MB_SYSTEMMODAL, "", "An example of why Dim can cause more problems than solve them.")

Example()

Func Example()
MsgBox($MB_SYSTEMMODAL, "", $vVariableThatIsGlobal) ; That looks alright to me as it displays the following text: This is a variable that has "Program Scope" aka Global.

Local $vReturn = SomeFunc() ; Call some random function.

MsgBox($MB_SYSTEMMODAL, $vReturn, $vVariableThatIsGlobal) ; The Global variable ($vVariableThatIsGlobal) changed because I totally forgot I had a duplicate variable name in "SomeFunc".
EndFunc ;==>Example

Func SomeFunc()
; This should create a variable in Local scope if the variable name doesn"t already exist.
; For argument sake I totally forgot that I declared a variable already with the same name.
; Well I only want this to be changed in the function and not the variable at the top of the script.
; Should be OK right? Think again.
Dim $vVariableThatIsGlobal = ""

For $i = 1 To 10
$vVariableThatIsGlobal &= $i ; This will return 12345678910 totally wiping the previous contents of $vVariableThatIsGlobal.
Next
Return $vVariableThatIsGlobal
EndFunc ;==>SomeFunc
</syntaxhighlight>

<span id="jumpsec1">Declaring Global variables in a Function is never a good idea:</span>
<syntaxhighlight lang="autoit">
#include <MsgBoxConstants.au3>

; Calling Example() first will initialise the Global variable $vVariableThatIsGlobal and therefore calling SomeFunc() won't return an error.
; Now look at Example 2.
Example()

Func Example()
; Declaring a variable in a function can cause serious problems, hence why all Global variables should be declared at the top of a script.
Global $vVariableThatIsGlobal = 'This is a variable that has ''File Scope'' aka Global.'
SomeFunc()
EndFunc ;==>Example

Func SomeFunc()
MsgBox($MB_SYSTEMMODAL, '', $vVariableThatIsGlobal) ; As the variable was initialised this will not return an error.
EndFunc ;==>SomeFunc
</syntaxhighlight>

Example 2:
<syntaxhighlight lang="autoit">
#include <MsgBoxConstants.au3>

; Calling SomeFunc() first will bypass the Global variable $vVariableThatIsGlobal being initialised and therefore AutoIt has no idea of what data the variable
; $vVariableThatIsGlobal contains.
SomeFunc()

Func Example()
; Declaring a variable in a function can cause serious problems, hence why all Global variables should be declared at the top of a script.
Global $vVariableThatIsGlobal = 'This is a variable that has ''File Scope'' aka Global.'
SomeFunc()
EndFunc ;==>Example

Func SomeFunc()
MsgBox($MB_SYSTEMMODAL, '', $vVariableThatIsGlobal) ; As the variable wasn't initialised this will return an error of "variable used without being declared."
EndFunc ;==>SomeFunc
</syntaxhighlight>

Declaring variables in loops (For, While, Do etc..) can have an affect on efficiency:
<syntaxhighlight lang="autoit">
#include <MsgBoxConstants.au3>

; Declaring variables inside loops should be avoided as the variable is re-declared on each repetition.
For $i = 1 To 10 ; $i is in 'loop scope.'
Local $iInt = $i
Next
MsgBox($MB_SYSTEMMODAL, '', $iInt) ; This will display 10.
</syntaxhighlight>

<syntaxhighlight lang="autoit">
#include <MsgBoxConstants.au3>

; Declaring variables outside of loops is more efficent in the long run.
Local $iInt = 0
For $i = 1 To 10 ; $i is in 'loop scope.'
$iInt = $i
Next
MsgBox($MB_SYSTEMMODAL, '', $iInt) ; This will display 10.
</syntaxhighlight>

There is no requirement to declare the iteration count variable in a loop:
<syntaxhighlight lang="autoit">
; Correct
Local Const $iCount = 99
Local $aArray[$iCount]
For $i = 0 To UBound($iCount) - 1 ; $i is only used in the loop, so there is no requirement to declare it.
$aArray[$i] = $i
Next

; Incorrect
Local Const $iCount = 99
Local $aArray[$iCount]
Local $i ; This is only used to store the iteration count value in the loop and therefore doesn't need to be declared. This is known as loop scope.
For $i = 0 To UBound($iCount) - 1
$aArray[$i] = $i
Next
</syntaxhighlight>
As you can see, there is the Const keyword in the example, we are going to talk about it.

== Const, Static, Enum ==

=== Const ===
We won't talk about the advantages of a constant variable, they are neglibible (for your information, an autoit constant variable is marked as read-only and remains a variable as read-only when compiled).

The Const keyword may be used in a first by some of you to avoid re-assignments.
The best way to use them is not this last case, the constants should be used for real static variables, meaning that their value won't change regardless to the instance of the program.

Example:
<syntaxhighlight lang="autoit">
;Bad
Local Const $hGUI = GUICreate("MyGUI")
; The handle of the window is unique, it's generated by Windows and changes.

;Good
Local Const $iMyAge = 19
</syntaxhighlight>

=== Static ===
Static variables are the solution to the global variables used in only one function.
e.g: Retain variable data once returned from a Function and only use that variable in that particular Function.
<syntaxhighlight lang="autoit">
Example()

Func Example()
SomeFunc() ; This will display a message box of 1, 1.
SomeFunc() ; This will display a message box of 1, 2.
SomeFunc() ; This will display a message box of 1, 3.
EndFunc ;==>Example

Func SomeFunc()
; This initialises a Static variable in Local scope. When a variable is declared just in Local scope (within a Function,)
; it's destroyed when the Function ends/returns. This isn't the case for a Static variable. The variable can't be
; accessed from anywhere else in the script apart from the Function it was declared in.
Local Static $vVariableThatIsStatic = 0
Local $vVariableThatIsLocal = 0
$vVariableThatIsLocal += 1 ; This will always be 1 as it was destroyed once returned from SomeFunc.
$vVariableThatIsStatic += 1 ; This will increase by 1.
MsgBox(4096, $vVariableThatIsLocal, $vVariableThatIsStatic)
EndFunc ;==>SomeFunc
</syntaxhighlight>

=== Enum ===
This statement is often practical in certain situations:
<syntaxhighlight lang="autoit">
#include <MsgBoxConstants.au3>

Example()

Func Example()
; Create variables in Local scope and enumerate through the variables. Default is to start from 0.
Local Enum $eCat, $eDog, $eMouse, $eHamster ; $eHamster is equal to the value 3, not 4.

; Create an array in Local scope with 4 elements.
Local $aAnimalNames[4]

; Assign each array element with the name of the respective animal. For example the name of the cat is Jasper.
$aAnimalNames[$eCat] = 'Jasper' ; $eCat is equal to 0, similar to using $aAnimalNames[0]
$aAnimalNames[$eDog] = 'Beethoven' ; $eDog is equal to 1, similar to using $aAnimalNames[1]
$aAnimalNames[$eMouse] = 'Pinky' ; $eMouse is equal to 2, similar to using $aAnimalNames[2]
$aAnimalNames[$eHamster] = 'Fidget' ; $eHamster is equal to 3, similar to using $aAnimalNames[3]

; Display the values of the array.
MsgBox($MB_SYSTEMMODAL, '', '$aAnimalNames[$eCat] = ' & $aAnimalNames[$eCat] & @CRLF & _
'$aAnimalNames[$eDog] = ' & $aAnimalNames[$eDog] & @CRLF & _
'$aAnimalNames[$eMouse] = ' & $aAnimalNames[$eMouse] & @CRLF & _
'$aAnimalNames[$eHamster] = ' & $aAnimalNames[$eHamster] & @CRLF)

; Sometimes using this approach for accessing an element is more practical than using a numerical value, due to the fact changing the index value of
; the enum constant has no affect on it's position in the array. Therefore changing the location of $eCat in the array is as simple as changing the order
; it appears in the initial declaration e.g.

; Local Enum $eDog, $eMouse, $eCat, $eHamster

; Now $eCat is the 2nd element in the array. If you were using numerical values, you would have to manually change all references of $aAnimalNames[0] to
; $aAnimalNames[2], as well as for the other elements which have now shifted.
EndFunc ;==>Example
</syntaxhighlight>

== Au3Check directive ==
As you may know (and we hope), the Au3Check tool checks your code for syntax errors, variables used without being declared etc. which is a good thing to fix your script.

With the official custom directive used to check the helpfile examples/includes, you can apply the good coding practices listed above:
<syntaxhighlight lang="autoit">
#AutoIt3Wrapper_Au3Check_Parameters=-q -d -w 1 -w 2 -w 3 -w- 4 -w 5 -w 6 -w- 7
</syntaxhighlight>

== Magic Numbers ==
Magic numbers are arbitrary numbers interspersed throughout a program's source code which do not have an associated identifier. The downside to this is not being able to derive a meaning from the number.

For example:
<syntaxhighlight lang="autoit">
MsgBox(262144, "Magic Numbers", "It's Adventure Time!")
</syntaxhighlight>
In this example, the magic number is 262144 with the identifier being $MB_TOPMOST according to the helpfile.

The corrected example:
<syntaxhighlight lang="autoit">
MsgBox($MB_TOPMOST, "Magic Numbers", "It's Adventure Time!")
</syntaxhighlight>

Example 2:
<syntaxhighlight lang="autoit">
; Imagine you're a new user to AutoIt and you come across this code, where would you find -3, -4 or -5 in the help file?
; Since AutoIt is relatively a new concept to you, your first thought isn't to search through all the include files, I mean
; why would you, the help file is there for a reason.
Example()

Func Example()
Local $hGUI = GUICreate('')
GUICtrlCreateLabel('Why magic numbers are counter productive.', 5, 5)
GUICtrlSetState(Default, 128) ; Does this hide, show or disable it?
GUICtrlSetState(Default, 64) ; Does this hide, show or disable it?
GUISetState(@SW_SHOW, $hGUI)

While 1
Switch GUIGetMsg()
Case -3 ; Doesn't really tell much about what it does.
ExitLoop

Case -4, -5 ; Again, no idea what these are. MouseMove? MouseClick? Restore?
MsgBox(4096, '', 'Do something when this action takes place.')

EndSwitch
WEnd

GUIDelete($hGUI)
EndFunc ;==>Example
</syntaxhighlight>

Did you understand the numbers were these:
<syntaxhighlight lang="autoit">
#include <GUIConstantsEx.au3>

Example()

Func Example()
Local $hGUI = GUICreate('')
GUICtrlCreateLabel('Why magic numbers are counter productive.', 5, 5)
GUICtrlSetState(Default, $GUI_DISABLE) ; Better, this is documented in the help file.
GUICtrlSetState(Default, $GUI_ENABLE) ; Better, this is documented in the help file.
GUISetState(@SW_SHOW, $hGUI)

While 1
Switch GUIGetMsg()
Case $GUI_EVENT_CLOSE ; Better, this is documented in the help file. Ah, it's the close action.
ExitLoop

Case $GUI_EVENT_MINIMIZE, $GUI_EVENT_RESTORE ; Better, this is documented in the help file.
MsgBox($MB_SYSTEMMODAL, '', 'Do something when this action takes place.') ; Better, this is documented in the help file.

EndSwitch
WEnd

GUIDelete($hGUI)
EndFunc ;==>Example
</syntaxhighlight>

[http://en.wikipedia.org/wiki/Magic_number_(programming) Magic number (programming)]

== Include-once directive ==
This one is designed for standard includes and UDFs, it's highly recommended to use it.

Those includes may be included in more than one script of your project because they are needed for some includes or your script itself.
In that case, the code will be duplicated which is not a good thing especially if you have (and it's mainly the case) constants declared in those files, in so far as the constants cannot be redeclared/reassigned; same thing for functions.

Put the directive in top of your UDF (library) to avoid itself to be included more than once :
<syntaxhighlight lang="autoit">
#include-once
</syntaxhighlight>

SciTE4AutoIt3

2015-02-28T20:05:02Z

Jaberwocky6669: /* Help Files */ Added wikilink to Documentation

__TOC__

== Introduction ==

'''SciTE4AutoIt3''' is a specialist editor package based on the excellent [http://www.scintilla.org/SciTE.html SciTE] editor.
SciTE has been set up to compile AutoIt scripts and has been extended with a multitude of Lua scripts.
SciTE4AutoIt3 may be downloaded here: [http://www.AutoItscript.com/site/AutoIt-script-editor/ SciTE4AutoIt3].
Keep in mind that SciTE4AutoIt3 is not an official package.
Direct any bug reports or feature requests to the AutoIt3 forum and not the bug tracker.

== Syntax Highlighting ==

[[File:Syntax_Highlighting.JPG|right|A demonstration of syntax highlighting using the default theme.]]

SciTE4AutoIt3 comes with a customized AutoIt3 lexer which enables syntax highlighting.
Syntax highlighting enables the colorization of various code elements such as variables, strings, operators, comments etc.
Syntax highlighting allows one to differentiate the various code elements such as keywords, variables, strings, control flow structures etc. quickly without having to specifically identify the element.
To load a custom theme a user may press [Ctrl] + [1] to bring up [[SciTEConfig]].
When the ''Color Settings'' tab is selected a button labeled 'New Scheme' will appear at the bottom.
Alternatively, the colors may be customized individually.

Some options that are available for customization include: White Space, Comment Line, Comment Block, Number, Function, Keyword, Macro and String.

== Quick Tips ==

For anyone not familiar with SciTE, here are a few tips and tricks to help easily customize the installation.
For any advanced info, visit the [http://www.scintilla.org/SciTEDoc.html SciTE home page].

=== Help Files ===

To access the AutoIt3 helpfile the user may press [F1]. For the full article see: [[Documentation]]
To quickly access help information on a specific function, simply click or highlight the desired function and press the [F1] key to bring up the help file on the relevant page.
To access the SciTE4AutoIt3 helpfile the user may press [ctrl] + [F1].

=== Properties Files ===

Minor editing of SciTE's configuration files will be required to make use of the information in this section.
It is important to be familiar with the hierarchy of SciTE's configuration files.

There are four properties files used:

{| border="1" class="wikitable"
| SciTE.properties || Local properties file which may be present in the same directory as the file being edited. This file overrides any other properties files settings below. This file is user created.
|-
| SciTEDirectory.properties || Directory properties file which may be present in the same or in a parent directory as the file being edited.
This file overrides all properties setting of the files below, but not the local properties settings aka ''SciTE.properties''.
This file is user created.
|-
| SciTEUser.properties || User properties file, this file's settings override only the global properties settings aka ''SciTEGlobal.properties''.
This file is found under the current logged on users profile directory.
|-
| SciTEGlobal.properties || All settings in this file can be overridden by any of the above files.
Typically this file should not be edited.
Use any of the above methods to implement a setting change.
This file can be found in SciTE's installation directory.
|}

=== Inline Errors ===

[[File:InlineError.JPG|234px|thumb|right|Intentional error prone code used to display the "Inline Error" feature.]]

In the latest version of SciTE, there exists a new feature called "Inline Errors".
Inline Error marks are error messages that will appear in the source code within the Scintilla window.

The feature may be toggled and customized by using SciTEConfig.

=== Selection Highlighting ===

Selection highlighting is a new feature which highlights other instances of the currently highlighted word or string.
Due to the colors, sometimes it is hard to tell the selection apart.
The default colors may be changed.

The feature may be toggled and customized by using SciTEConfig.

=== Colors in the Output Pane ===

SciTE has a console window which can be used to output information from running scripts.
The function {{Help File|ConsoleWrite}} may be used in an AutoIt script to output text to the console.
The colors of the text may be altered by prepending a string with special characters.

For example:

<syntaxhighlight lang="AutoIt">
ConsoleWrite("This is plain text" & @LF)
ConsoleWrite("> This text will have a different color." & @LF)
ConsoleWrite("+ This text will have a different color." & @LF)
ConsoleWrite("- This text will have a different color." & @LF)
ConsoleWrite("! This text will have a different color." & @LF)
</syntaxhighlight>

== AutoIt3Wrapper ==

AutoIt3Wrapper directives allow for in depth control of the compilation and interpretation of AutoIt scripts.
Some of these can be very useful under different circumstances.
See [[AutoIt3Wrapper Directives]] for a full list of directives and their descriptions.

== Au3Stripper ==

[[Au3Stripper]] may be used to strip away unused [[Function|functions]] and [[Global|global]] [[Variable|variables]] from the script prior to compilation.
Functions and variables may be renamed to shorter three character names to save space and to provide some measure of obscurity.

=== Stripping Excess Code ===

For instance, in a script that has several includes Au3Stripper can often strip thousands of lines from the script.

#AutoIt3Wrapper_Run_Au3Stripper=y
#Au3Stripper_Parameters=/sf /sv /rm

On a medium sized script, results are often like this:

>Running Au3Stripper (1.2.0.6) from:C:\Program Files\AutoIt3\SciTE cmdline:
- Iteration 1 Strip Functions result: Output 2580 lines and stripped 6741 lines
- Iteration 2 Strip Variables result: Output 1585 lines and stripped 950 lines
- Iteration 3 Strip Variables result: Output 1566 lines and stripped 19 lines
- Iteration 4 Start the actual Obfuscation.
+> Source 26190 lines 1447980 Characters.
+> Stripped 7710 Func/Var lines and 16862 comment lines, Total 1373871 Characters.
+> Saved 93% lines 94% Characters.
+> Au3Stripper v1.0.27.0 finished obfuscating 1566 lines, created:C:\MyScript_stripped.au3

== Run_After and Run_Before Commands ==

=== Running the exe On Build ===

Often a build is performed as a testing procedure and so to have to continually open up Windows Explorer to find the exe is repetitive.
Furthermore, if the script writes to the console using the function {{Help File|ConsoleWrite}} then the messages will not be written to SciTE's console pane. The solution is simple:

#AutoIt3Wrapper_Run_After="%out%"

This will run the program and read the console output to the SciTE debug frame.

=== Creating a Version Directory ===

When compiling, it is very possible that you want to go back to a previous version.
If so, then it is neat to have a directory which will store all previous builds, without the need for you to manually copy and paste every time.
Make sure you add these directives in last (after adding resources) as they might not be included in the copied result.

#AutoIt3Wrapper_Run_After=md "%scriptdir%\Versions\%fileversion%"
#AutoIt3Wrapper_Run_After=copy "%in%" "%scriptdir%\Versions\%fileversion%\%scriptfile%%fileversion%.au3"
#AutoIt3Wrapper_Run_After=copy "%out%" "%scriptdir%\Versions\%fileversion%\%scriptfile%%fileversion%.exe"

=== Using ResHacker ===

ResHacker is a very important programming tool for extracting and adding resources into executables.
It has a very simple command line interface that allows it to be used easily using the "Run_After" directive.
Adding a picture to an executable could be done like this:

#AutoIt3Wrapper_Run_After=ResHacker.exe -add %out%, %out%, MyPicture.bmp, BITMAP, RESOURCENAME, 0

NB: Reshacker.exe ''must'' be copied into the script directory for this to work.

If you then want to use the resources in your code, there is an excellent [http://www.AutoItscript.com/forum/index.php?showtopic=51103 Resources UDF] which will allow you to access the resources from within the exe.

==== Adding Original Source Code ====

When using the above tip on stripping excess code, the new source is not readable.
As a result, using the standard directive for saving the source:

#AutoIt3Wrapper_Res_SaveSource=y

Would add the obfuscated code to the exe, which is not the desired result.
The solution is to add it in manually.
This code does not require any editing, so you can just copy and paste it in:

#AutoIt3Wrapper_Run_After=ResHacker.exe -add %out%, %out%, %scriptfile%.au3, RCDATA, SOURCE, 0

==== Extended Reshacker Info ====

ResHacker doesn't always return with a return code (rc) of not 0 if it fails, to get that info you need to read the ResHacker.log file that is created. This is also pretty simple to do:

#AutoIt3Wrapper_Run_After=ResHacker.exe -add %out%, %out%, MyPicture.bmp, BITMAP, RESOURCENAME, 0
#AutoIt3Wrapper_Run_After=TYPE ResHacker.log

The new output now looks like this:

>Running:ResHacker.exe -add C:\MyScript.exe, C:\MyScript.exe, MyPicture.bmp, BITMAP, RESOURCENAME, 0
>ResHacker.exe -add C:\MyScript.exe, C:\MyScript.exe, MyPicture.bmp, BITMAP, RESOURCENAME, 0 Ended rc:0
>Running:TYPE ResHacker.log
[19 Jan 2010, 21:26:22]
ResHacker.exe -add C:\MyScript.exe, C:\MyScript.exe, MyPicture.bmp, BITMAP, RESOURCENAME, 0
Added: BITMAP,RESOURCENAME,0

Commands completed
>TYPE ResHacker.log Ended rc:0

And an example of it showing an error:

>ResHacker.exe -add C:\MyScript.exe, C:\MyScript.exe, MyPicture.bmp, BITMAP, RESOURCENAME, 0 Ended rc:0
>Running:TYPE ResHacker.log
[19 Jan 2010, 21:32:10]
ResHacker.exe -add C:\MyScript.exe, C:\MyScript.exe, MyPicture.bmp, BITMAP, RESOURCENAME, 0
Error: "MyPicture.bmp" does not exist
>TYPE ResHacker.log Ended rc:0

As you can see, Reshacker on its own returns rc: 0, usually indicating no error. This would have gone completely unnoticed except for the log file, which shows the error and an explanation.

=== Other Run_After and Run_Before Commands ===

You can use any commands you like in the Run_After and Run_Before directives. Examples such as "TYPE" have been shown above.

For a more complete list the following website is very useful: [http://ss64.com/nt An A-Z Index of the Windows CMD Line]

== Other Wiki Pages ==

[[Adding_utilities_to_the_SciTE_Tools_menu|Adding Utilities to the SciTE Tools Menu]]

[[Adding_UDFs_to_AutoIt_and_SciTE|Adding UDFs to AutoIt and SciTE]]

== Useful Lua links and scripts ==

[http://www.scintilla.org/SciTELua.html SciTELua]

[http://www.lua.org Lua Website]

[http://www.lua.org/pil/1.html Programming in Lua]

[http://lua-users.org/wiki/ lua-users wiki]

[http://lua-users.org/wiki/SciTEScripts SciTEScripts]

[http://lua-users.org/wiki/SampleCode SampleCode]

[http://www.AutoItscript.com/forum/topic/140881-mouse-hover-call-tips-update-03182013/ AutoIt3 Forum: MouseHoverCallTips]

[http://www.AutoItscript.com/forum/topic/152960-SciTE-lua-tool-to-make-string-variable-from-selected-text/ AutoIt3 Forum: SciTE lua Tool To Make String Variable From Selected Text]

[[Category:SciTE]]

AutoIt3Wrapper Directives

2015-02-12T18:01:32Z

Jaberwocky6669: /* AU3Stripper */ Placed directives into a table.

__TOC__

== List of AutoIt3Wrapper Directives ==

This is a list of compiler directives used by AutoIt3Wrapper.exe and their descriptions.

== AutoIt3 ==

{| border="1" class="wikitable"
!! scope="col" | Directive
!! scope="col" | Options
!! scope="col" | Description
!! scope="col" | Default
|-
| #AutoIt3Wrapper_testing || (Y/N) || Skip Tidy, Obfuscator and cvsWrapper for speed while testing. || N
|-
| #AutoIt3Wrapper_UseX64 || (Y/N) || Use X64 versions for AutoIt3_x64 or AUT2EXE_x64. || N
|-
| #AutoIt3Wrapper_Version || (B/P) || Use Beta or Production for AutoIt3 and AUT2EXE. || P
|-
| #AutoIt3Wrapper_Run_Debug_Mode || (Y/N) || Run Script with console debugging. || N
|-
| #AutoIt3Wrapper_Run_SciTE_Minimized || (Y/N) || Minimize SciTE while script is running. || N
|-
| #AutoIt3Wrapper_Run_SciTE_OutputPane_Minimized || (Y/N) || Toggle SciTE output pane at run time so its not shown. || N
|-
| #AutoIt3Wrapper_Autoit3Dir || || Optionally override the base AutoIt3 install directory. ||
|-
| #AutoIt3Wrapper_Aut2exe || || Optionally override the Aut2exe.exe to use for this script ||
|-
| #AutoIt3Wrapper_AutoIt3 || || Optionally override the Autoit3.exe to use for this script ||
|-
| #AutoIt3Wrapper_Add_Constants || || Add the needed standard constant include files. Will only run one time. ||
|}

== AUT2EXE ==

{| border="1" class="wikitable"
!! scope="col" | Directive
!! scope="col" | Options
!! scope="col" | Description
!! scope="col" | Default
|-
| #AutoIt3Wrapper_Icon || || Filename of the Ico file to use ||
|-
| #AutoIt3Wrapper_OutFile || || Target exe/a3x filename. ||
|-
| #AutoIt3Wrapper_OutFile_Type || || a3x=small AutoIt3 file exe=Standalone executable || exe
|-
| #AutoIt3Wrapper_OutFile_X64 || || Target exe filename for X64 compile. ||
|-
| #AutoIt3Wrapper_Compression || || Compression parameter 0-40=Low 2=normal 4=High. || 2
|-
| #AutoIt3Wrapper_UseUpx || (Y/N) || Compress output program. || Y
|-
| #AutoIt3Wrapper_UPX_Parameters || || Override the default setting for UPX. ||
|-
| #AutoIt3Wrapper_Change2CUI || (Y/N) || Change output program to CUI in stead of GUI. || N
|-
| #AutoIt3Wrapper_Compile_both || (Y/N) || Compile both X86 and X64 in one run. || N
|}

== Target Program Resource Info ==

{| border="1" class="wikitable"
!! scope="col" | Directive
!! scope="col" | Options
!! scope="col" | Description
!! scope="col" | Default
|-
| #AutoIt3Wrapper_Res_Comment || || Comment field ||
|-
| #AutoIt3Wrapper_Res_Description|| || Description field ||
|-
| #AutoIt3Wrapper_Res_Fileversion || || File Version ||
|-
| #AutoIt3Wrapper_Res_FileVersion_AutoIncrement || (Y/N/P) || AutoIncrement FileVersion After AUTEXE is finished. P=Prompt, Will ask at compilation time if you want to increase the version number || N
|-
| #AutoIt3Wrapper_Res_ProductVersion || || Product Version. || Default is the AutoIt3 version used.
|-
| #AutoIt3Wrapper_Res_Language || || Resource Language code. || 2057 which is English (United Kingdom)
|-
| #AutoIt3Wrapper_Res_LegalCopyright || || Copyright field ||
|-
| #AutoIt3Wrapper_res_requestedExecutionLevel || || asInvoker, highestAvailable, requireAdministrator or None (remove the trustInfo section). || Default is the setting from AUT2EXE - asInvoker.
|-
| #AutoIt3Wrapper_res_Compatibility || || Vista, Windows7 both allowed separated by a comma. || None
|-
| #AutoIt3Wrapper_Res_SaveSource || (Y/N) || Save a copy of the script source in the EXE resources. If Y then the content of the script source depends on the #AutoIt3Wrapper_Run_Obfuscator and #obfuscator_parameters directives. || N
|}

=== Add Extra Files to The Resources ===

A maximum of fifteen free form resource fields.The following variables are available:

%AutoItVer% = will be replaced with the version of AutoIt3

%date% = PC date in short date format

%longdate% = PC date in long date format

%time% = PC timeformat

An example:
#AutoIt3Wrapper_Res_Field=AutoIt Version|%AutoItVer%
#AutoIt3Wrapper_Res_Field=Free format fieldname|fieldvalue
#AutoIt3Wrapper_Res_Field=Free format fieldname|fieldvalue
#AutoIt3Wrapper_Res_Field=Free format fieldname|fieldvalue

Add extra ICO files to the resources which can be used with TraySetIcon(@ScriptFullPath, 5) etc.

list of filename of the Ico files to be added, First one will have number 5, then 6 etc.

#AutoIt3Wrapper_Res_Icon_AddFilename[,LanguageCode] of ICO to be added.

#AutoIt3Wrapper_Res_File_AddFilename[,Section [,ResName[,LanguageCode]]] to be added.

== Tidy ==

{| border="1" class="wikitable"
!! scope="col" | Directive
!! scope="col" | Options
!! scope="col" | Description
!! scope="col" | Default
|-
| #AutoIt3Wrapper_Run_Tidy || (Y/N)|| Run Tidy before compilation. || N
|-
| #AutoIt3Wrapper_Tidy_Stop_OnError || (Y/N) || Continue when only Warnings. || Y
|-
| #Tidy_Parameters || || See the SciTE4AutoIt3 helpfile for options. ||
|}

== AU3Stripper ==

The directives used within the script to control Au3Stripper are as follows:

{| border="1" class="wikitable"
!! scope="col" | Directive
!! scope="col" | Options
!! scope="col" | Description
!! scope="col" | Default
|-
| #AutoIt3Wrapper_Run_Au3Stripper || (y/n) || Run Au3Stripper before compilation. || n
|-
| #Au3Stripper_Parameters || || Use the parameters as listed below. ||
|-
| #Au3Stripper_Off || || Stop the Stripping process below this line. ||
|-
| #Au3Stripper_On || || Start the Stripping process below this line. ||
|-
| #Au3Stripper_Ignore_Funcs || || Do not Strip these functions. ||
|-
| #Au3Stripper_Ignore_Variables || || Do not Strip these variables. ||
|}

{| border="1" class="wikitable"
|+ Parameters
!! scope="col" | Directive
!! scope="col" | Options
!! scope="col" | Description
!! scope="col" | Default
|-
| PreExpand || || Replace and reference to a Global Const variable with its actual value. ||
|-
| StripOnly || (SF/SV) || || SV = 1
|-
| StripUnusedFunc || || Remove unused Funcs. || 0
|-
| StripUnusedVars || || Remove unused Global variable declarations. || 0
|-
| StripOnlyIncludes || || Same as /SO but leaves the main script untouched. ||
|-
| MergeOnly || || Will produce a scriptfile as AUT2EXE includes in the Compiled EXE. This allows you to find the proper linenumber when errors are reported. ||
|-
| RenameMinimum || || Generates a much smaller file by substituting function and variable names with unique 2+-character names. ||
|-
| ShowConsoleInfo || (0/1/9) || 0 = Minimal output to the console - only warnings and errors. 1 = Show more progress information 9 = Show all debug lines as found in the Au3Stripper.log. || 0
|-
| Beta || || Use the ...\AutoIt\Beta\Include files if installed. ||
|}

== AU3Check ==

{| border="1" class="wikitable"
!! scope="col" | Directive
!! scope="col" | Options
!! scope="col" | Description
!! scope="col" | Default
|-
| #AutoIt3Wrapper_Run_AU3Check || (Y/N) || Run au3check before compilation. || Y
|-
| #AutoIt3Wrapper_AU3Check_Parameters || || Au3Check parameters ||
|-
| #AutoIt3Wrapper_AU3Check_Stop_OnWarning || (Y/N) || N=Continue on Warnings. || Y (Always stop on warnings.)
|-
| #AutoIt3Wrapper_PlugIn_Funcs || || Define PlugIn function names separated by a comma to avoid AU3Check errors. ||
|}

== Versioning ==

{| border="1" class="wikitable"
!! scope="col" | Directive
!! scope="col" | Options
!! scope="col" | Description
!! scope="col" | Default
|-
| #AutoIt3Wrapper_Versioning || (Y/N/V) || Run versioning to update the script source. V=only run when fileversion is increased by #AutoIt3Wrapper_Res_FileVersion_AutoIncrement. || N
|-
| #AutoIt3Wrapper_Versioning_Parameters || || /NoPrompt: Will skip the Comments prompt /Comments: Text to added in the Comments. It can also contain the below variables. ||
|}

== Run Before And After Directives ==

The following directives can contain: these variables

%in% , %out%, %outx64%, %icon% which will be replaced by the fullpath\filename.

%scriptdir% same as @ScriptDir and %scriptfile% = filename without extension.

%fileversion% is the information from the #AutoIt3Wrapper_Res_Fileversion directive

%scitedir% will be replaced by the SciTE program directory

%autoitdir% will be replaced by the AutoIt3 program directory

<pre>
#AutoIt3Wrapper_Run_Before process to run before compilation.
You can have multiple records that will be processed in sequence.

#AutoIt3Wrapper_Run_After process to run after compilation.
You can have multiple records that will be processed in sequence.
</pre>

== Conditional Directives ==

Optional use this format for the supported directives to have seperate directive values for Run and Compile.

The GUI is not available when this format is used.

<pre>
#AutoIt3Wrapper_If_Run
#AutoIt3Wrapper_Run_AU3Check=y
#AutoIt3Wrapper_Jump_To_First_Error=y
#AutoIt3Wrapper_AU3Check_Parameters=-q -d -w 1 -w 2 -w 3 -w 4 -w 5 -w 6
#AutoIt3Wrapper_AU3Check_Stop_OnWarning=n
#AutoIt3Wrapper_Run_Tidy=n
#Tidy_Parameters=
#AutoIt3Wrapper_Tidy_Stop_onerror=n
#AutoIt3Wrapper_If_Compile
#AutoIt3Wrapper_Run_AU3Check=y
#AutoIt3Wrapper_Jump_To_First_Error=y
#AutoIt3Wrapper_AU3Check_Parameters=-q -d -w 1 -w 2 -w 3 -w 4 -w 5 -w 6
#AutoIt3Wrapper_AU3Check_Stop_OnWarning=y
#AutoIt3Wrapper_Run_Tidy=y
#Tidy_Parameters=/gd /nsdp
#AutoIt3Wrapper_Tidy_Stop_onerror=y
#AutoIt3Wrapper_EndIf
</pre>

SciTE4AutoIt3

2014-09-20T11:25:12Z

Jaberwocky6669: /* Inline Errors */ Added note about using SciTEConfig to configure this setting.

__TOC__

== Introduction ==

'''SciTE4AutoIt3''' is a specialist editor package based on the excellent [http://www.scintilla.org/SciTE.html SciTE] editor.
SciTE has been set up to compile AutoIt scripts and has been extended with a multitude of Lua scripts.
SciTE4AutoIt3 may be downloaded here: [http://www.AutoItscript.com/site/AutoIt-script-editor/ SciTE4AutoIt3].
Keep in mind that SciTE4AutoIt3 is not an official package.
Direct any bug reports or feature requests to the AutoIt3 forum and not the bug tracker.

== Syntax Highlighting ==

[[File:Syntax_Highlighting.JPG|right|A demonstration of syntax highlighting using the default theme.]]

SciTE4AutoIt3 comes with a customized AutoIt3 lexer which enables syntax highlighting.
Syntax highlighting enables the colorization of various code elements such as variables, strings, operators, comments etc.
Syntax highlighting allows one to differentiate the various code elements such as keywords, variables, strings, control flow structures etc. quickly without having to specifically identify the element.
To load a custom theme a user may press [Ctrl] + [1] to bring up [[SciTEConfig]].
When the ''Color Settings'' tab is selected a button labeled 'New Scheme' will appear at the bottom.
Alternatively, the colors may be customized individually.

Some options that are available for customization include: White Space, Comment Line, Comment Block, Number, Function, Keyword, Macro and String.

== Quick Tips ==

For anyone not familiar with SciTE, here are a few tips and tricks to help easily customize the installation.
For any advanced info, visit the [http://www.scintilla.org/SciTEDoc.html SciTE home page].

=== Help Files ===

To access the AutoIt3 helpfile the user may press [F1].
To quickly access help information on a specific function, simply click or highlight the desired function and press the [F1] key to bring up the help file on the relevant page.
To access the SciTE4AutoIt3 helpfile the user may press [ctrl] + [F1].
For SciTE related help, use the key combination [Ctrl] + [F1] to bring up a help file detailing SciTE related help documentation.

=== Properties Files ===

Minor editing of SciTE's configuration files will be required to make use of the information in this section.
It is important to be familiar with the hierarchy of SciTE's configuration files.

There are four properties files used:

{| border="1" class="wikitable"
| SciTE.properties || Local properties file which may be present in the same directory as the file being edited. This file overrides any other properties files settings below. This file is user created.
|-
| SciTEDirectory.properties || Directory properties file which may be present in the same or in a parent directory as the file being edited.
This file overrides all properties setting of the files below, but not the local properties settings aka ''SciTE.properties''.
This file is user created.
|-
| SciTEUser.properties || User properties file, this file's settings override only the global properties settings aka ''SciTEGlobal.properties''.
This file is found under the current logged on users profile directory.
|-
| SciTEGlobal.properties || All settings in this file can be overridden by any of the above files.
Typically this file should not be edited.
Use any of the above methods to implement a setting change.
This file can be found in SciTE's installation directory.
|}

=== Inline Errors ===

[[File:InlineError.JPG|234px|thumb|right|Intentional error prone code used to display the "Inline Error" feature.]]

In the latest version of SciTE, there exists a new feature called "Inline Errors".
Inline Error marks are error messages that will appear in the source code within the Scintilla window.

The feature may be toggled and customized by using SciTEConfig.

=== Selection Highlighting ===

Selection highlighting is a new feature which highlights other instances of the currently highlighted word or string.
Due to the colors, sometimes it is hard to tell the selection apart.
The default colors may be changed.

The feature may be toggled and customized by using SciTEConfig.

=== Colors in the Output Pane ===

SciTE has a console window which can be used to output information from running scripts.
The function {{Help File|ConsoleWrite}} may be used in an AutoIt script to output text to the console.
The colors of the text may be altered by prepending a string with special characters.

For example:

<syntaxhighlight lang="AutoIt">
ConsoleWrite("This is plain text" & @LF)
ConsoleWrite("> This text will have a different color." & @LF)
ConsoleWrite("+ This text will have a different color." & @LF)
ConsoleWrite("- This text will have a different color." & @LF)
ConsoleWrite("! This text will have a different color." & @LF)
</syntaxhighlight>

== AutoIt3Wrapper ==

AutoIt3Wrapper directives allow for in depth control of the compilation and interpretation of AutoIt scripts.
Some of these can be very useful under different circumstances.
See [[AutoIt3Wrapper Directives]] for a full list of directives and their descriptions.

== Au3Stripper ==

[[Au3Stripper]] may be used to strip away unused [[Function|functions]] and [[Global|global]] [[Variable|variables]] from the script prior to compilation.
Functions and variables may be renamed to shorter three character names to save space and to provide some measure of obscurity.

=== Stripping Excess Code ===

For instance, in a script that has several includes Au3Stripper can often strip thousands of lines from the script.

#AutoIt3Wrapper_Run_Au3Stripper=y
#Au3Stripper_Parameters=/sf /sv /rm

On a medium sized script, results are often like this:

>Running Au3Stripper (1.2.0.6) from:C:\Program Files\AutoIt3\SciTE cmdline:
- Iteration 1 Strip Functions result: Output 2580 lines and stripped 6741 lines
- Iteration 2 Strip Variables result: Output 1585 lines and stripped 950 lines
- Iteration 3 Strip Variables result: Output 1566 lines and stripped 19 lines
- Iteration 4 Start the actual Obfuscation.
+> Source 26190 lines 1447980 Characters.
+> Stripped 7710 Func/Var lines and 16862 comment lines, Total 1373871 Characters.
+> Saved 93% lines 94% Characters.
+> Au3Stripper v1.0.27.0 finished obfuscating 1566 lines, created:C:\MyScript_stripped.au3

== Run_After and Run_Before Commands ==

=== Running the exe On Build ===

Often a build is performed as a testing procedure and so to have to continually open up Windows Explorer to find the exe is repetitive.
Furthermore, if the script writes to the console using the function {{Help File|ConsoleWrite}} then the messages will not be written to SciTE's console pane. The solution is simple:

#AutoIt3Wrapper_Run_After="%out%"

This will run the program and read the console output to the SciTE debug frame.

=== Creating a Version Directory ===

When compiling, it is very possible that you want to go back to a previous version.
If so, then it is neat to have a directory which will store all previous builds, without the need for you to manually copy and paste every time.
Make sure you add these directives in last (after adding resources) as they might not be included in the copied result.

#AutoIt3Wrapper_Run_After=md "%scriptdir%\Versions\%fileversion%"
#AutoIt3Wrapper_Run_After=copy "%in%" "%scriptdir%\Versions\%fileversion%\%scriptfile%%fileversion%.au3"
#AutoIt3Wrapper_Run_After=copy "%out%" "%scriptdir%\Versions\%fileversion%\%scriptfile%%fileversion%.exe"

=== Using ResHacker ===

ResHacker is a very important programming tool for extracting and adding resources into executables.
It has a very simple command line interface that allows it to be used easily using the "Run_After" directive.
Adding a picture to an executable could be done like this:

#AutoIt3Wrapper_Run_After=ResHacker.exe -add %out%, %out%, MyPicture.bmp, BITMAP, RESOURCENAME, 0

NB: Reshacker.exe ''must'' be copied into the script directory for this to work.

If you then want to use the resources in your code, there is an excellent [http://www.AutoItscript.com/forum/index.php?showtopic=51103 Resources UDF] which will allow you to access the resources from within the exe.

==== Adding Original Source Code ====

When using the above tip on stripping excess code, the new source is not readable.
As a result, using the standard directive for saving the source:

#AutoIt3Wrapper_Res_SaveSource=y

Would add the obfuscated code to the exe, which is not the desired result.
The solution is to add it in manually.
This code does not require any editing, so you can just copy and paste it in:

#AutoIt3Wrapper_Run_After=ResHacker.exe -add %out%, %out%, %scriptfile%.au3, RCDATA, SOURCE, 0

==== Extended Reshacker Info ====

ResHacker doesn't always return with a return code (rc) of not 0 if it fails, to get that info you need to read the ResHacker.log file that is created. This is also pretty simple to do:

#AutoIt3Wrapper_Run_After=ResHacker.exe -add %out%, %out%, MyPicture.bmp, BITMAP, RESOURCENAME, 0
#AutoIt3Wrapper_Run_After=TYPE ResHacker.log

The new output now looks like this:

>Running:ResHacker.exe -add C:\MyScript.exe, C:\MyScript.exe, MyPicture.bmp, BITMAP, RESOURCENAME, 0
>ResHacker.exe -add C:\MyScript.exe, C:\MyScript.exe, MyPicture.bmp, BITMAP, RESOURCENAME, 0 Ended rc:0
>Running:TYPE ResHacker.log
[19 Jan 2010, 21:26:22]
ResHacker.exe -add C:\MyScript.exe, C:\MyScript.exe, MyPicture.bmp, BITMAP, RESOURCENAME, 0
Added: BITMAP,RESOURCENAME,0

Commands completed
>TYPE ResHacker.log Ended rc:0

And an example of it showing an error:

>ResHacker.exe -add C:\MyScript.exe, C:\MyScript.exe, MyPicture.bmp, BITMAP, RESOURCENAME, 0 Ended rc:0
>Running:TYPE ResHacker.log
[19 Jan 2010, 21:32:10]
ResHacker.exe -add C:\MyScript.exe, C:\MyScript.exe, MyPicture.bmp, BITMAP, RESOURCENAME, 0
Error: "MyPicture.bmp" does not exist
>TYPE ResHacker.log Ended rc:0

As you can see, Reshacker on its own returns rc: 0, usually indicating no error. This would have gone completely unnoticed except for the log file, which shows the error and an explanation.

=== Other Run_After and Run_Before Commands ===

You can use any commands you like in the Run_After and Run_Before directives. Examples such as "TYPE" have been shown above.

For a more complete list the following website is very useful: [http://ss64.com/nt An A-Z Index of the Windows CMD Line]

== Other Wiki Pages ==

[[Adding_utilities_to_the_SciTE_Tools_menu|Adding Utilities to the SciTE Tools Menu]]

[[Adding_UDFs_to_AutoIt_and_SciTE|Adding UDFs to AutoIt and SciTE]]

== Useful Lua links and scripts ==

[http://www.scintilla.org/SciTELua.html SciTELua]

[http://www.lua.org Lua Website]

[http://www.lua.org/pil/1.html Programming in Lua]

[http://lua-users.org/wiki/ lua-users wiki]

[http://lua-users.org/wiki/SciTEScripts SciTEScripts]

[http://lua-users.org/wiki/SampleCode SampleCode]

[http://www.AutoItscript.com/forum/topic/140881-mouse-hover-call-tips-update-03182013/ AutoIt3 Forum: MouseHoverCallTips]

[http://www.AutoItscript.com/forum/topic/152960-SciTE-lua-tool-to-make-string-variable-from-selected-text/ AutoIt3 Forum: SciTE lua Tool To Make String Variable From Selected Text]

[[Category:SciTE]]

SciTE4AutoIt3

2014-06-11T14:01:01Z

Jaberwocky6669: /* Selection Highlighting */ Added note about using SciTEConfig to alter selection highlighting settings.

__TOC__

== Introduction ==

'''SciTE4AutoIt3''' is a specialist editor package based on the excellent [http://www.scintilla.org/SciTE.html SciTE] editor.
SciTE has been set up to compile AutoIt scripts and has been extended with a multitude of Lua scripts.
SciTE4AutoIt3 may be downloaded here: [http://www.AutoItscript.com/site/AutoIt-script-editor/ SciTE4AutoIt3].
Keep in mind that SciTE4AutoIt3 is not an official package.
Direct any bug reports or feature requests to the AutoIt3 forum and not the bug tracker.

== Syntax Highlighting ==

[[File:Syntax_Highlighting.JPG|right|A demonstration of syntax highlighting using the default theme.]]

SciTE4AutoIt3 comes with a customized AutoIt3 lexer which enables syntax highlighting.
Syntax highlighting enables the colorization of various code elements such as variables, strings, operators, comments etc.
Syntax highlighting allows one to differentiate the various code elements such as keywords, variables, strings, control flow structures etc. quickly without having to specifically identify the element.
To load a custom theme a user may press [Ctrl] + [1] to bring up [[SciTEConfig]].
When the ''Color Settings'' tab is selected a button labeled 'New Scheme' will appear at the bottom.
Alternatively, the colors may be customized individually.

Some options that are available for customization include: White Space, Comment Line, Comment Block, Number, Function, Keyword, Macro and String.

== Quick Tips ==

For anyone not familiar with SciTE, here are a few tips and tricks to help easily customize the installation.
For any advanced info, visit the [http://www.scintilla.org/SciTEDoc.html SciTE home page].

=== Help Files ===

To access the AutoIt3 helpfile the user may press [F1].
To quickly access help information on a specific function, simply click or highlight the desired function and press the [F1] key to bring up the help file on the relevant page.
To access the SciTE4AutoIt3 helpfile the user may press [ctrl] + [F1].
For SciTE related help, use the key combination [Ctrl] + [F1] to bring up a help file detailing SciTE related help documentation.

=== Properties Files ===

Minor editing of SciTE's configuration files will be required to make use of the information in this section.
It is important to be familiar with the hierarchy of SciTE's configuration files.

There are four properties files used:

{| border="1" class="wikitable"
| SciTE.properties || Local properties file which may be present in the same directory as the file being edited. This file overrides any other properties files settings below. This file is user created.
|-
| SciTEDirectory.properties || Directory properties file which may be present in the same or in a parent directory as the file being edited.
This file overrides all properties setting of the files below, but not the local properties settings aka ''SciTE.properties''.
This file is user created.
|-
| SciTEUser.properties || User properties file, this file's settings override only the global properties settings aka ''SciTEGlobal.properties''.
This file is found under the current logged on users profile directory.
|-
| SciTEGlobal.properties || All settings in this file can be overridden by any of the above files.
Typically this file should not be edited.
Use any of the above methods to implement a setting change.
This file can be found in SciTE's installation directory.
|}

=== Inline Errors ===

[[File:InlineError.JPG|234px|thumb|right|Intentional error prone code used to display the "Inline Error" feature.]]

In the latest version of SciTE, there exists a new feature called "Inline Errors".
Inline Error marks are error messages that will appear in the source code within the Scintilla window.
Inline errors may be quickly toggled using ''SciTEUser.properties''.

Open the SciTE user properties file in a text editor by selecting from the SciTE menu ''Options''.
Open ''User Options File'' and add the following code to the file.

To disable:

<syntaxhighlight lang="properties">error.inline=0</syntaxhighlight>

To enable:

<syntaxhighlight lang="properties">error.inline=1</syntaxhighlight>

=== Selection Highlighting ===

Selection highlighting is a new feature which highlights other instances of the currently highlighted word or string.
Due to the colors, sometimes it is hard to tell the selection apart.
The default colors may be changed.

The feature may be toggled and customized by using SciTEConfig.

=== Colors in the Output Pane ===

SciTE has a console window which can be used to output information from running scripts.
The function {{Help File|ConsoleWrite}} may be used in an AutoIt script to output text to the console.
The colors of the text may be altered by prepending a string with special characters.

For example:

<syntaxhighlight lang="AutoIt">
ConsoleWrite("This is plain text" & @LF)
ConsoleWrite("> This text will have a different color." & @LF)
ConsoleWrite("+ This text will have a different color." & @LF)
ConsoleWrite("- This text will have a different color." & @LF)
ConsoleWrite("! This text will have a different color." & @LF)
</syntaxhighlight>

== AutoIt3Wrapper ==

AutoIt3Wrapper directives allow for in depth control of the compilation and interpretation of AutoIt scripts.
Some of these can be very useful under different circumstances.
See [[AutoIt3Wrapper Directives]] for a full list of directives and their descriptions.

== Au3Stripper ==

[[Au3Stripper]] may be used to strip away unused [[Function|functions]] and [[Global|global]] [[Variable|variables]] from the script prior to compilation.
Functions and variables may be renamed to shorter three character names to save space and to provide some measure of obscurity.

=== Stripping Excess Code ===

For instance, in a script that has several includes Au3Stripper can often strip thousands of lines from the script.

#AutoIt3Wrapper_Run_Au3Stripper=y
#Au3Stripper_Parameters=/sf /sv /rm

On a medium sized script, results are often like this:

>Running Au3Stripper (1.2.0.6) from:C:\Program Files\AutoIt3\SciTE cmdline:
- Iteration 1 Strip Functions result: Output 2580 lines and stripped 6741 lines
- Iteration 2 Strip Variables result: Output 1585 lines and stripped 950 lines
- Iteration 3 Strip Variables result: Output 1566 lines and stripped 19 lines
- Iteration 4 Start the actual Obfuscation.
+> Source 26190 lines 1447980 Characters.
+> Stripped 7710 Func/Var lines and 16862 comment lines, Total 1373871 Characters.
+> Saved 93% lines 94% Characters.
+> Au3Stripper v1.0.27.0 finished obfuscating 1566 lines, created:C:\MyScript_stripped.au3

== Run_After and Run_Before Commands ==

=== Running the exe On Build ===

Often a build is performed as a testing procedure and so to have to continually open up Windows Explorer to find the exe is repetitive.
Furthermore, if the script writes to the console using the function {{Help File|ConsoleWrite}} then the messages will not be written to SciTE's console pane. The solution is simple:

#AutoIt3Wrapper_Run_After="%out%"

This will run the program and read the console output to the SciTE debug frame.

=== Creating a Version Directory ===

When compiling, it is very possible that you want to go back to a previous version.
If so, then it is neat to have a directory which will store all previous builds, without the need for you to manually copy and paste every time.
Make sure you add these directives in last (after adding resources) as they might not be included in the copied result.

#AutoIt3Wrapper_Run_After=md "%scriptdir%\Versions\%fileversion%"
#AutoIt3Wrapper_Run_After=copy "%in%" "%scriptdir%\Versions\%fileversion%\%scriptfile%%fileversion%.au3"
#AutoIt3Wrapper_Run_After=copy "%out%" "%scriptdir%\Versions\%fileversion%\%scriptfile%%fileversion%.exe"

=== Using ResHacker ===

ResHacker is a very important programming tool for extracting and adding resources into executables.
It has a very simple command line interface that allows it to be used easily using the "Run_After" directive.
Adding a picture to an executable could be done like this:

#AutoIt3Wrapper_Run_After=ResHacker.exe -add %out%, %out%, MyPicture.bmp, BITMAP, RESOURCENAME, 0

NB: Reshacker.exe ''must'' be copied into the script directory for this to work.

If you then want to use the resources in your code, there is an excellent [http://www.AutoItscript.com/forum/index.php?showtopic=51103 Resources UDF] which will allow you to access the resources from within the exe.

==== Adding Original Source Code ====

When using the above tip on stripping excess code, the new source is not readable.
As a result, using the standard directive for saving the source:

#AutoIt3Wrapper_Res_SaveSource=y

Would add the obfuscated code to the exe, which is not the desired result.
The solution is to add it in manually.
This code does not require any editing, so you can just copy and paste it in:

#AutoIt3Wrapper_Run_After=ResHacker.exe -add %out%, %out%, %scriptfile%.au3, RCDATA, SOURCE, 0

==== Extended Reshacker Info ====

ResHacker doesn't always return with a return code (rc) of not 0 if it fails, to get that info you need to read the ResHacker.log file that is created. This is also pretty simple to do:

#AutoIt3Wrapper_Run_After=ResHacker.exe -add %out%, %out%, MyPicture.bmp, BITMAP, RESOURCENAME, 0
#AutoIt3Wrapper_Run_After=TYPE ResHacker.log

The new output now looks like this:

>Running:ResHacker.exe -add C:\MyScript.exe, C:\MyScript.exe, MyPicture.bmp, BITMAP, RESOURCENAME, 0
>ResHacker.exe -add C:\MyScript.exe, C:\MyScript.exe, MyPicture.bmp, BITMAP, RESOURCENAME, 0 Ended rc:0
>Running:TYPE ResHacker.log
[19 Jan 2010, 21:26:22]
ResHacker.exe -add C:\MyScript.exe, C:\MyScript.exe, MyPicture.bmp, BITMAP, RESOURCENAME, 0
Added: BITMAP,RESOURCENAME,0

Commands completed
>TYPE ResHacker.log Ended rc:0

And an example of it showing an error:

>ResHacker.exe -add C:\MyScript.exe, C:\MyScript.exe, MyPicture.bmp, BITMAP, RESOURCENAME, 0 Ended rc:0
>Running:TYPE ResHacker.log
[19 Jan 2010, 21:32:10]
ResHacker.exe -add C:\MyScript.exe, C:\MyScript.exe, MyPicture.bmp, BITMAP, RESOURCENAME, 0
Error: "MyPicture.bmp" does not exist
>TYPE ResHacker.log Ended rc:0

As you can see, Reshacker on its own returns rc: 0, usually indicating no error. This would have gone completely unnoticed except for the log file, which shows the error and an explanation.

=== Other Run_After and Run_Before Commands ===

You can use any commands you like in the Run_After and Run_Before directives. Examples such as "TYPE" have been shown above.

For a more complete list the following website is very useful: [http://ss64.com/nt An A-Z Index of the Windows CMD Line]

== Other Wiki Pages ==

[[Adding_utilities_to_the_SciTE_Tools_menu|Adding Utilities to the SciTE Tools Menu]]

[[Adding_UDFs_to_AutoIt_and_SciTE|Adding UDFs to AutoIt and SciTE]]

== Useful Lua links and scripts ==

[http://www.scintilla.org/SciTELua.html SciTELua]

[http://www.lua.org Lua Website]

[http://www.lua.org/pil/1.html Programming in Lua]

[http://lua-users.org/wiki/ lua-users wiki]

[http://lua-users.org/wiki/SciTEScripts SciTEScripts]

[http://lua-users.org/wiki/SampleCode SampleCode]

[http://www.AutoItscript.com/forum/topic/140881-mouse-hover-call-tips-update-03182013/ AutoIt3 Forum: MouseHoverCallTips]

[http://www.AutoItscript.com/forum/topic/152960-SciTE-lua-tool-to-make-string-variable-from-selected-text/ AutoIt3 Forum: SciTE lua Tool To Make String Variable From Selected Text]

[[Category:SciTE]]

AutoIt3Wrapper Directives

2014-06-11T13:57:07Z

Jaberwocky6669: Added AU3Stripper section.

__TOC__

== List of AutoIt3Wrapper Directives ==

This is a list of compiler directives used by AutoIt3Wrapper.exe and their descriptions.

== AutoIt3 ==

{| border="1" class="wikitable"
!! scope="col" | Directive
!! scope="col" | Options
!! scope="col" | Description
!! scope="col" | Default
|-
| #AutoIt3Wrapper_testing || (Y/N) || Skip Tidy, Obfuscator and cvsWrapper for speed while testing. || N
|-
| #AutoIt3Wrapper_UseX64 || (Y/N) || Use X64 versions for AutoIt3_x64 or AUT2EXE_x64. || N
|-
| #AutoIt3Wrapper_Version || (B/P) || Use Beta or Production for AutoIt3 and AUT2EXE. || P
|-
| #AutoIt3Wrapper_Run_Debug_Mode || (Y/N) || Run Script with console debugging. || N
|-
| #AutoIt3Wrapper_Run_SciTE_Minimized || (Y/N) || Minimize SciTE while script is running. || N
|-
| #AutoIt3Wrapper_Run_SciTE_OutputPane_Minimized || (Y/N) || Toggle SciTE output pane at run time so its not shown. || N
|-
| #AutoIt3Wrapper_Autoit3Dir || || Optionally override the base AutoIt3 install directory. ||
|-
| #AutoIt3Wrapper_Aut2exe || || Optionally override the Aut2exe.exe to use for this script ||
|-
| #AutoIt3Wrapper_AutoIt3 || || Optionally override the Autoit3.exe to use for this script ||
|-
| #AutoIt3Wrapper_Add_Constants || || Add the needed standard constant include files. Will only run one time. ||
|}

== AUT2EXE ==

{| border="1" class="wikitable"
!! scope="col" | Directive
!! scope="col" | Options
!! scope="col" | Description
!! scope="col" | Default
|-
| #AutoIt3Wrapper_Icon || || Filename of the Ico file to use ||
|-
| #AutoIt3Wrapper_OutFile || || Target exe/a3x filename. ||
|-
| #AutoIt3Wrapper_OutFile_Type || || a3x=small AutoIt3 file exe=Standalone executable || exe
|-
| #AutoIt3Wrapper_OutFile_X64 || || Target exe filename for X64 compile. ||
|-
| #AutoIt3Wrapper_Compression || || Compression parameter 0-40=Low 2=normal 4=High. || 2
|-
| #AutoIt3Wrapper_UseUpx || (Y/N) || Compress output program. || Y
|-
| #AutoIt3Wrapper_UPX_Parameters || || Override the default setting for UPX. ||
|-
| #AutoIt3Wrapper_Change2CUI || (Y/N) || Change output program to CUI in stead of GUI. || N
|-
| #AutoIt3Wrapper_Compile_both || (Y/N) || Compile both X86 and X64 in one run. || N
|}

== Target Program Resource Info ==

{| border="1" class="wikitable"
!! scope="col" | Directive
!! scope="col" | Options
!! scope="col" | Description
!! scope="col" | Default
|-
| #AutoIt3Wrapper_Res_Comment || || Comment field ||
|-
| #AutoIt3Wrapper_Res_Description|| || Description field ||
|-
| #AutoIt3Wrapper_Res_Fileversion || || File Version ||
|-
| #AutoIt3Wrapper_Res_FileVersion_AutoIncrement || (Y/N/P) || AutoIncrement FileVersion After AUTEXE is finished. P=Prompt, Will ask at compilation time if you want to increase the version number || N
|-
| #AutoIt3Wrapper_Res_ProductVersion || || Product Version. || Default is the AutoIt3 version used.
|-
| #AutoIt3Wrapper_Res_Language || || Resource Language code. || 2057 which is English (United Kingdom)
|-
| #AutoIt3Wrapper_Res_LegalCopyright || || Copyright field ||
|-
| #AutoIt3Wrapper_res_requestedExecutionLevel || || asInvoker, highestAvailable, requireAdministrator or None (remove the trustInfo section). || Default is the setting from AUT2EXE - asInvoker.
|-
| #AutoIt3Wrapper_res_Compatibility || || Vista, Windows7 both allowed separated by a comma. || None
|-
| #AutoIt3Wrapper_Res_SaveSource || (Y/N) || Save a copy of the script source in the EXE resources. If Y then the content of the script source depends on the #AutoIt3Wrapper_Run_Obfuscator and #obfuscator_parameters directives. || N
|}

=== Add Extra Files to The Resources ===

A maximum of fifteen free form resource fields.The following variables are available:

%AutoItVer% = will be replaced with the version of AutoIt3

%date% = PC date in short date format

%longdate% = PC date in long date format

%time% = PC timeformat

An example:
#AutoIt3Wrapper_Res_Field=AutoIt Version|%AutoItVer%
#AutoIt3Wrapper_Res_Field=Free format fieldname|fieldvalue
#AutoIt3Wrapper_Res_Field=Free format fieldname|fieldvalue
#AutoIt3Wrapper_Res_Field=Free format fieldname|fieldvalue

Add extra ICO files to the resources which can be used with TraySetIcon(@ScriptFullPath, 5) etc.

list of filename of the Ico files to be added, First one will have number 5, then 6 etc.

#AutoIt3Wrapper_Res_Icon_AddFilename[,LanguageCode] of ICO to be added.

#AutoIt3Wrapper_Res_File_AddFilename[,Section [,ResName[,LanguageCode]]] to be added.

== Tidy ==

{| border="1" class="wikitable"
!! scope="col" | Directive
!! scope="col" | Options
!! scope="col" | Description
!! scope="col" | Default
|-
| #AutoIt3Wrapper_Run_Tidy || (Y/N)|| Run Tidy before compilation. || N
|-
| #AutoIt3Wrapper_Tidy_Stop_OnError || (Y/N) || Continue when only Warnings. || Y
|-
| #Tidy_Parameters || || See the SciTE4AutoIt3 helpfile for options. ||
|}

== AU3Stripper ==

{| border="1" class="wikitable"
!! scope="col" | Directive
!! scope="col" | Options
!! scope="col" | Description
!! scope="col" | Default
|-
| PreExpand || || Replace and reference to a Global Const variable with its actual value. ||
|-
| StripOnly || (SF/SV) || || SV = 1
|-
| StripUnusedFunc || || Remove unused Funcs. || 0
|-
| StripUnusedVars || || Remove unused Global variable declarations. || 0
|-
| StripOnlyIncludes || || Same as /SO but leaves the main script untouched. ||
|-
| MergeOnly || || Will produce a scriptfile as AUT2EXE includes in the Compiled EXE. This allows you to find the proper linenumber when errors are reported. ||
|-
| RenameMinimum || || Generates a much smaller file by substituting function and variable names with unique 2+-character names. ||
|-
| ShowConsoleInfo || (0/1/9) || 0 = Minimal output to the console - only warnings and errors. 1 = Show more progress information 9 = Show all debug lines as found in the Au3Stripper.log. || 0
|-
| Beta || || Use the ...\AutoIt\Beta\Include files if installed. ||
|}

The directives used within the script to control Au3Stripper are as follows:

#AutoIt3Wrapper_Run_Au3Stripper=y Run Au3Stripper before compilation (Default=n)
#Au3Stripper_Parameters= Use the parameters as listed above
#Au3Stripper_Off Stop the Stripping process below this line
#Au3Stripper_On Start the Stripping process below this line
#Au3Stripper_Ignore_Funcs= Do not Strip these functions
#Au3Stripper_Ignore_Variables= Do not Strip these variables

== AU3Check ==

{| border="1" class="wikitable"
!! scope="col" | Directive
!! scope="col" | Options
!! scope="col" | Description
!! scope="col" | Default
|-
| #AutoIt3Wrapper_Run_AU3Check || (Y/N) || Run au3check before compilation. || Y
|-
| #AutoIt3Wrapper_AU3Check_Parameters || || Au3Check parameters ||
|-
| #AutoIt3Wrapper_AU3Check_Stop_OnWarning || (Y/N) || N=Continue on Warnings. || Y (Always stop on warnings.)
|-
| #AutoIt3Wrapper_PlugIn_Funcs || || Define PlugIn function names separated by a comma to avoid AU3Check errors. ||
|}

== Versioning ==

{| border="1" class="wikitable"
!! scope="col" | Directive
!! scope="col" | Options
!! scope="col" | Description
!! scope="col" | Default
|-
| #AutoIt3Wrapper_Versioning || (Y/N/V) || Run versioning to update the script source. V=only run when fileversion is increased by #AutoIt3Wrapper_Res_FileVersion_AutoIncrement. || N
|-
| #AutoIt3Wrapper_Versioning_Parameters || || /NoPrompt: Will skip the Comments prompt /Comments: Text to added in the Comments. It can also contain the below variables. ||
|}

== Run Before And After Directives ==

The following directives can contain: these variables

%in% , %out%, %outx64%, %icon% which will be replaced by the fullpath\filename.

%scriptdir% same as @ScriptDir and %scriptfile% = filename without extension.

%fileversion% is the information from the #AutoIt3Wrapper_Res_Fileversion directive

%scitedir% will be replaced by the SciTE program directory

%autoitdir% will be replaced by the AutoIt3 program directory

<pre>
#AutoIt3Wrapper_Run_Before process to run before compilation.
You can have multiple records that will be processed in sequence.

#AutoIt3Wrapper_Run_After process to run after compilation.
You can have multiple records that will be processed in sequence.
</pre>

== Conditional Directives ==

Optional use this format for the supported directives to have seperate directive values for Run and Compile.

The GUI is not available when this format is used.

<pre>
#AutoIt3Wrapper_If_Run
#AutoIt3Wrapper_Run_AU3Check=y
#AutoIt3Wrapper_Jump_To_First_Error=y
#AutoIt3Wrapper_AU3Check_Parameters=-q -d -w 1 -w 2 -w 3 -w 4 -w 5 -w 6
#AutoIt3Wrapper_AU3Check_Stop_OnWarning=n
#AutoIt3Wrapper_Run_Tidy=n
#Tidy_Parameters=
#AutoIt3Wrapper_Tidy_Stop_onerror=n
#AutoIt3Wrapper_If_Compile
#AutoIt3Wrapper_Run_AU3Check=y
#AutoIt3Wrapper_Jump_To_First_Error=y
#AutoIt3Wrapper_AU3Check_Parameters=-q -d -w 1 -w 2 -w 3 -w 4 -w 5 -w 6
#AutoIt3Wrapper_AU3Check_Stop_OnWarning=y
#AutoIt3Wrapper_Run_Tidy=y
#Tidy_Parameters=/gd /nsdp
#AutoIt3Wrapper_Tidy_Stop_onerror=y
#AutoIt3Wrapper_EndIf
</pre>

AutoIt3Wrapper Directives

2014-06-11T13:47:33Z

Jaberwocky6669: Removed Obfuscator section.

__TOC__

== List of AutoIt3Wrapper Directives ==

This is a list of compiler directives used by AutoIt3Wrapper.exe and their descriptions.

== AutoIt3 ==

{| border="1" class="wikitable"
!! scope="col" | Directive
!! scope="col" | Options
!! scope="col" | Description
!! scope="col" | Default
|-
| #AutoIt3Wrapper_testing || (Y/N) || Skip Tidy, Obfuscator and cvsWrapper for speed while testing. || N
|-
| #AutoIt3Wrapper_UseX64 || (Y/N) || Use X64 versions for AutoIt3_x64 or AUT2EXE_x64. || N
|-
| #AutoIt3Wrapper_Version || (B/P) || Use Beta or Production for AutoIt3 and AUT2EXE. || P
|-
| #AutoIt3Wrapper_Run_Debug_Mode || (Y/N) || Run Script with console debugging. || N
|-
| #AutoIt3Wrapper_Run_SciTE_Minimized || (Y/N) || Minimize SciTE while script is running. || N
|-
| #AutoIt3Wrapper_Run_SciTE_OutputPane_Minimized || (Y/N) || Toggle SciTE output pane at run time so its not shown. || N
|-
| #AutoIt3Wrapper_Autoit3Dir || || Optionally override the base AutoIt3 install directory. ||
|-
| #AutoIt3Wrapper_Aut2exe || || Optionally override the Aut2exe.exe to use for this script ||
|-
| #AutoIt3Wrapper_AutoIt3 || || Optionally override the Autoit3.exe to use for this script ||
|-
| #AutoIt3Wrapper_Add_Constants || || Add the needed standard constant include files. Will only run one time. ||
|}

== AUT2EXE ==

{| border="1" class="wikitable"
!! scope="col" | Directive
!! scope="col" | Options
!! scope="col" | Description
!! scope="col" | Default
|-
| #AutoIt3Wrapper_Icon || || Filename of the Ico file to use ||
|-
| #AutoIt3Wrapper_OutFile || || Target exe/a3x filename. ||
|-
| #AutoIt3Wrapper_OutFile_Type || || a3x=small AutoIt3 file exe=Standalone executable || exe
|-
| #AutoIt3Wrapper_OutFile_X64 || || Target exe filename for X64 compile. ||
|-
| #AutoIt3Wrapper_Compression || || Compression parameter 0-40=Low 2=normal 4=High. || 2
|-
| #AutoIt3Wrapper_UseUpx || (Y/N) || Compress output program. || Y
|-
| #AutoIt3Wrapper_UPX_Parameters || || Override the default setting for UPX. ||
|-
| #AutoIt3Wrapper_Change2CUI || (Y/N) || Change output program to CUI in stead of GUI. || N
|-
| #AutoIt3Wrapper_Compile_both || (Y/N) || Compile both X86 and X64 in one run. || N
|}

== Target Program Resource Info ==

{| border="1" class="wikitable"
!! scope="col" | Directive
!! scope="col" | Options
!! scope="col" | Description
!! scope="col" | Default
|-
| #AutoIt3Wrapper_Res_Comment || || Comment field ||
|-
| #AutoIt3Wrapper_Res_Description|| || Description field ||
|-
| #AutoIt3Wrapper_Res_Fileversion || || File Version ||
|-
| #AutoIt3Wrapper_Res_FileVersion_AutoIncrement || (Y/N/P) || AutoIncrement FileVersion After AUTEXE is finished. P=Prompt, Will ask at compilation time if you want to increase the version number || N
|-
| #AutoIt3Wrapper_Res_ProductVersion || || Product Version. || Default is the AutoIt3 version used.
|-
| #AutoIt3Wrapper_Res_Language || || Resource Language code. || 2057 which is English (United Kingdom)
|-
| #AutoIt3Wrapper_Res_LegalCopyright || || Copyright field ||
|-
| #AutoIt3Wrapper_res_requestedExecutionLevel || || asInvoker, highestAvailable, requireAdministrator or None (remove the trustInfo section). || Default is the setting from AUT2EXE - asInvoker.
|-
| #AutoIt3Wrapper_res_Compatibility || || Vista, Windows7 both allowed separated by a comma. || None
|-
| #AutoIt3Wrapper_Res_SaveSource || (Y/N) || Save a copy of the script source in the EXE resources. If Y then the content of the script source depends on the #AutoIt3Wrapper_Run_Obfuscator and #obfuscator_parameters directives. || N
|}

=== Add Extra Files to The Resources ===

A maximum of fifteen free form resource fields.The following variables are available:

%AutoItVer% = will be replaced with the version of AutoIt3

%date% = PC date in short date format

%longdate% = PC date in long date format

%time% = PC timeformat

An example:
#AutoIt3Wrapper_Res_Field=AutoIt Version|%AutoItVer%
#AutoIt3Wrapper_Res_Field=Free format fieldname|fieldvalue
#AutoIt3Wrapper_Res_Field=Free format fieldname|fieldvalue
#AutoIt3Wrapper_Res_Field=Free format fieldname|fieldvalue

Add extra ICO files to the resources which can be used with TraySetIcon(@ScriptFullPath, 5) etc.

list of filename of the Ico files to be added, First one will have number 5, then 6 etc.

#AutoIt3Wrapper_Res_Icon_AddFilename[,LanguageCode] of ICO to be added.

#AutoIt3Wrapper_Res_File_AddFilename[,Section [,ResName[,LanguageCode]]] to be added.

== Tidy ==

{| border="1" class="wikitable"
!! scope="col" | Directive
!! scope="col" | Options
!! scope="col" | Description
!! scope="col" | Default
|-
| #AutoIt3Wrapper_Run_Tidy || (Y/N)|| Run Tidy before compilation. || N
|-
| #AutoIt3Wrapper_Tidy_Stop_OnError || (Y/N) || Continue when only Warnings. || Y
|-
| #Tidy_Parameters || || See the SciTE4AutoIt3 helpfile for options. ||
|}

== AU3Check ==

{| border="1" class="wikitable"
!! scope="col" | Directive
!! scope="col" | Options
!! scope="col" | Description
!! scope="col" | Default
|-
| #AutoIt3Wrapper_Run_AU3Check || (Y/N) || Run au3check before compilation. || Y
|-
| #AutoIt3Wrapper_AU3Check_Parameters || || Au3Check parameters ||
|-
| #AutoIt3Wrapper_AU3Check_Stop_OnWarning || (Y/N) || N=Continue on Warnings. || Y (Always stop on warnings.)
|-
| #AutoIt3Wrapper_PlugIn_Funcs || || Define PlugIn function names separated by a comma to avoid AU3Check errors. ||
|}

== Versioning ==

{| border="1" class="wikitable"
!! scope="col" | Directive
!! scope="col" | Options
!! scope="col" | Description
!! scope="col" | Default
|-
| #AutoIt3Wrapper_Versioning || (Y/N/V) || Run versioning to update the script source. V=only run when fileversion is increased by #AutoIt3Wrapper_Res_FileVersion_AutoIncrement. || N
|-
| #AutoIt3Wrapper_Versioning_Parameters || || /NoPrompt: Will skip the Comments prompt /Comments: Text to added in the Comments. It can also contain the below variables. ||
|}

== Run Before And After Directives ==

The following directives can contain: these variables

%in% , %out%, %outx64%, %icon% which will be replaced by the fullpath\filename.

%scriptdir% same as @ScriptDir and %scriptfile% = filename without extension.

%fileversion% is the information from the #AutoIt3Wrapper_Res_Fileversion directive

%scitedir% will be replaced by the SciTE program directory

%autoitdir% will be replaced by the AutoIt3 program directory

<pre>
#AutoIt3Wrapper_Run_Before process to run before compilation.
You can have multiple records that will be processed in sequence.

#AutoIt3Wrapper_Run_After process to run after compilation.
You can have multiple records that will be processed in sequence.
</pre>

== Conditional Directives ==

Optional use this format for the supported directives to have seperate directive values for Run and Compile.

The GUI is not available when this format is used.

<pre>
#AutoIt3Wrapper_If_Run
#AutoIt3Wrapper_Run_AU3Check=y
#AutoIt3Wrapper_Jump_To_First_Error=y
#AutoIt3Wrapper_AU3Check_Parameters=-q -d -w 1 -w 2 -w 3 -w 4 -w 5 -w 6
#AutoIt3Wrapper_AU3Check_Stop_OnWarning=n
#AutoIt3Wrapper_Run_Tidy=n
#Tidy_Parameters=
#AutoIt3Wrapper_Tidy_Stop_onerror=n
#AutoIt3Wrapper_If_Compile
#AutoIt3Wrapper_Run_AU3Check=y
#AutoIt3Wrapper_Jump_To_First_Error=y
#AutoIt3Wrapper_AU3Check_Parameters=-q -d -w 1 -w 2 -w 3 -w 4 -w 5 -w 6
#AutoIt3Wrapper_AU3Check_Stop_OnWarning=y
#AutoIt3Wrapper_Run_Tidy=y
#Tidy_Parameters=/gd /nsdp
#AutoIt3Wrapper_Tidy_Stop_onerror=y
#AutoIt3Wrapper_EndIf
</pre>

GUICreate

2013-08-27T10:33:17Z

Jaberwocky6669:

User:Jaberwocky6669/Sandbox

2013-08-25T14:06:11Z

Jaberwocky6669: Created page with "  <!-- If there is an error here then that means that there is an error in the helpfile or in my script..."

AutoItSetOption

2013-08-25T12:41:58Z

Jaberwocky6669:

<font face='Segoe UI, Courier New, Lucida Grande, Verdana, Helvetica, sans-serif'>

<font size='3' weight='normal'>Changes the operation of various AutoIt functions/parameters.</font>

<font face='Courier New'><div id='Syntax' style='background-color:#FFFFAA;'>

:AutoItSetOption ( "option" [, param] )

</div></font>

===<font size=4><div id='Section' style='color:#DB7100;'>Parameters</div></font>===
{| class='wikitable'
|-
| option || The option to change. See Remarks.
|-
| param || '''[optional]''' The value to assign to the option. The type and meaning vary by option. See remarks below. If the param is not provided, then the function just returns the value already assigned to the option. The keyword [http://www.autoitscript.com/autoit3/docs/keywords/Default.htm Default] can be used for the parameter to reset the option to its default value.
|}

===<font size=4><div id='Section' style='color:#DB7100;'>Return Value</div></font>===
{| class='wikitable'
| Success: || Returns the value of the previous setting for the option.
|-
| Failure: || Sets @error to non-zero. Failure will occur if the parameters are invalid (such as an option that doesn't exist).
|}

===<font size=4><div id='Section' style='color:#DB7100;'>Remarks</div></font>===
You may use Opt as an alternative to [[AutoItSetOption]].

Options are as follows:
{| class='wikitable'
|-
| '''Option''' || '''Param'''
|-
| CaretCoordMode || Sets the way coords are used in the caret functions, either absolute coords or coords relative to the current active window:

0 = relative coords to the active window

1 = absolute screen coordinates (default)

2 = relative coords to the client area of the active window
|-
| ExpandEnvStrings || Changes how literal strings and % symbols are interpreted. By default strings are treated literally, this option allows you to use %environment% variables inside strings, e.g., "The temp directory is: %temp%".

0 = do not expand environment variables (default)

1 = expand environment variables

Without this option the usual way would be: "The temp directory is: " & [[EnvGet]]("temp")
|-
| ExpandVarStrings || Changes how literal strings and variable/macro ($ and @) symbols are interpreted. By default strings are treated literally, this option allows you to use variables and macros inside strings, e.g., "The value of var1 is $var1$".

0 = do not expand variables (default)

1 = expand variables (when in this mode and you want to use a literal $ or @ then double it up: "This is a single dollar $$ sign".
|-
| GUICloseOnESC || When ESC is pressed on a GUI the $GUI_EVENT_CLOSE message is sent. This option toggles this behavior on and off.

0 = Don't send the $GUI_EVENT_CLOSE message when ESC is pressed.

1 = [[Send]] the $GUI_EVENT_CLOSE message when ESC is pressed (default).
|-
| GUICoordMode || Alters the position of a control defined by [[GUICtrlSetPos]].

0 = relative position to the start of the last control (upper left corner).

1 = absolute coordinates (default) still relative to the dialog box.

2 = cell positioning relative to current cell. A -1 for left or top parameter don't increment the start.

So next line is -1, offset; next cell is offset,-1; current cell is -1,-1.

Obviously "offset" cannot be -1 which reserved to indicate the no increment. But if you can use a multiple of the width you choose to skip or go back.
|-
| GUIDataSeparatorChar || Define the character which delimits subitems in [[GUICtrlSetData]].

The default character is '<nowiki>|</nowiki>'.
|-
| GUIOnEventMode || Enable/disable OnEvent functions notifications.

0 = (default) disable.

1 = enable.
|-
| GUIResizeMode || Change default resizing for a control.

0 = (default) keep default control resizing.

<1024 = any type of resizing see [[GUICtrlSetResizing]].
|-
| GUIEventOptions || Change special event behavior or GUI function return values.

0 = (default) Windows behavior on click on Minimize,Restore, Maximize, Resize.

1 = suppress windows behavior on minimize, restore or maximize click button or window resize. Just sends the notification.
|-
| MouseClickDelay || Alters the length of the brief pause in between mouse clicks.

Time in milliseconds to pause (default=10).
|-
| MouseClickDownDelay || Alters the length a click is held down before release.

Time in milliseconds to pause (default=10).
|-
| MouseClickDragDelay || Alters the length of the brief pause at the start and end of a mouse drag operation.

Time in milliseconds to pause (default=250).
|-
| MouseCoordMode || Sets the way coords are used in the mouse functions, either absolute coords or coords relative to the current active window:

0 = relative coords to the active window

1 = absolute screen coordinates (default)

2 = relative coords to the client area of the active window
|-
| MustDeclareVars || If this option is used then all variables must be pre-declared with Local, Global or in some cases Dim before they can be used - removes the chance for misspelled variables causing bugs.

0 = Variables don't need to be pre-declared (default)

1 = Variables must be pre-declared. See [http://www.autoitscript.com/autoit3/docs/keywords/Dim.htm Dim / Global / Local / Const] for details on declaring variables.
|-
| PixelCoordMode || Sets the way coords are used in the pixel functions, either absolute coords or coords relative to the window defined by hwnd (default active window):

0 = relative coords to the defined window

1 = absolute screen coordinates (default)

2 = relative coords to the client area of the defined window
|-
| SendAttachMode || Specifies if AutoIt attaches input threads when using [[Send]] function. When not attaching (default mode=0) detecting the state of capslock/scrolllock and numlock can be unreliable under NT4. However, when you specify attach mode=1 the [[Send]]("{... down/up}") syntax will not work and there may be problems with sending keys to "hung" windows. [[ControlSend]] ALWAYS attaches and is not affected by this mode.

0 = don't attach (default)

1 = attach
|-
| SendCapslockMode || Specifies if AutoIt should store the state of capslock before a [[Send]] function and restore it afterwards.

0 = don't store/restore

1 = store and restore (default)
|-
| SendKeyDelay || Alters the length of the brief pause in between sent keystrokes. A value of 0 removes the delay completely.

Time in milliseconds to pause (default=5).
|-
| SendKeyDownDelay || Alters the length of time a key is held down before being released during a keystroke. For applications that take a while to register keypresses you may need to raise this value from the default. A value of 0 removes the delay completely.

Time in milliseconds to pause (default=5).
|-
| TCPTimeout || Defines the time before TCP functions stop if no communication.

Time in milliseconds before timeout (default=100).
|-
| TrayAutoPause || Script pauses when click on tray icon.

0 = no pause

1 = pause (default). If there is no DefaultMenu no pause will occurs.
|-
| TrayIconDebug || If enabled shows the current script line in the tray icon tip to help debugging.

0 = no debug information (default)

1 = show debug
|-
| TrayIconHide || Hides the AutoIt tray icon. Note: The icon will still initially appear ~750 milliseconds.

0 = show icon (default)

1 = hide icon
|-
| TrayMenuMode || Extend the behaviour of the script tray icon/menu. This can be done with a combination (adding) of the following values.

0 = default menu items (Script Paused/Exit) are appended to the usercreated menu; usercreated checked items will automatically unchecked; if you double click the tray icon then the controlid is returned which has the "Default"-style (default).

1 = no default menu

2 = user created checked items will not automatically unchecked if you click it

4 = don't return the menuitemID which has the "default"-style in the main contextmenu if you double click the tray icon

8 = turn off auto check of radio item groups
|-
| TrayOnEventMode || Enable/disable OnEvent functions notifications for the tray.

0 = (default) disable

1 = enable
|-
| WinDetectHiddenText || Specifies if hidden window text can be "seen" by the window matching functions.

0 = Do not detect hidden text (default)

1 = Detect hidden text
|-
| WinSearchChildren || Allows the window search routines to search child windows as well as top-level windows.

0 = Only search top-level windows (default)

1 = Search top-level and child windows
|-
| WinTextMatchMode || Alters the method that is used to match window text during search operations.

1 = Complete / Slow mode (default)

2 = Quick mode

In quick mode AutoIt can usually only "see" dialog text, button text and the captions of some controls. In the default mode much more text can be seen (for instance the contents of the Notepad window).

If you are having performance problems when performing many window searches then changing to the "quick" mode may help.
|-
| WinTitleMatchMode || Alters the method that is used to match window titles during search operations.

1 = Match the title from the start (default)

2 = Match any substring in the title

3 = Exact title match

4 = Advanced mode, see [http://www.autoitscript.com/autoit3/docs/intro/windowsadvanced.htm Window Titles & Text (Advanced)]

-1 to -4 = Case insensitive match according to the other type of match.
|-
| WinWaitDelay || Alters how long a script should briefly pause after a successful window-related operation.

Time in milliseconds to pause (default=250).
|}

===<font size=4><div id='Section' style='color:#DB7100;'>Example</div></font>===
<syntaxhighlight lang='autoit'>
; copy any you want to change ;default value is listed first

Opt("CaretCoordMode", 1) ;1=absolute, 0=relative, 2=client
Opt("ExpandEnvStrings", 0) ;0=don't expand, 1=do expand
Opt("ExpandVarStrings", 0) ;0=don't expand, 1=do expand
Opt("GUICloseOnESC", 1) ;1=ESC closes, 0=ESC won't close
Opt("GUICoordMode", 1) ;1=absolute, 0=relative, 2=cell
Opt("GUIDataSeparatorChar", "|") ;"|" is the default
Opt("GUIOnEventMode", 0) ;0=disabled, 1=OnEvent mode enabled
Opt("GUIResizeMode", 0) ;0=no resizing, <1024 special resizing
Opt("GUIEventOptions", 0) ;0=default, 1=just notification, 2=GUICtrlRead tab index
Opt("MouseClickDelay", 10) ;10 milliseconds
Opt("MouseClickDownDelay", 10) ;10 milliseconds
Opt("MouseClickDragDelay", 250) ;250 milliseconds
Opt("MouseCoordMode", 1) ;1=absolute, 0=relative, 2=client
Opt("MustDeclareVars", 0) ;0=no, 1=require pre-declaration
Opt("PixelCoordMode", 1) ;1=absolute, 0=relative, 2=client
Opt("SendAttachMode", 0) ;0=don't attach, 1=do attach
Opt("SendCapslockMode", 1) ;1=store and restore, 0=don't
Opt("SendKeyDelay", 5) ;5 milliseconds
Opt("SendKeyDownDelay", 1) ;1 millisecond
Opt("TCPTimeout", 100) ;100 milliseconds
Opt("TrayAutoPause", 1) ;0=no pause, 1=Pause
Opt("TrayIconDebug", 0) ;0=no info, 1=debug line info
Opt("TrayIconHide", 0) ;0=show, 1=hide tray icon
Opt("TrayMenuMode", 0) ;0=append, 1=no default menu, 2=no automatic check, 4=menuitemID not return
Opt("TrayOnEventMode", 0) ;0=disable, 1=enable
Opt("WinDetectHiddenText", 0) ;0=don't detect, 1=do detect
Opt("WinSearchChildren", 1) ;0=no, 1=search children also
Opt("WinTextMatchMode", 1) ;1=complete, 2=quick
Opt("WinTitleMatchMode", 1) ;1=start, 2=subStr, 3=exact, 4=advanced, -1 to -4=Nocase
Opt("WinWaitDelay", 250) ;250 milliseconds
</syntaxhighlight>
</font>
__NOTOC__
__NOEDITSECTION__

AutoItSetOption

2013-08-25T05:22:44Z

Jaberwocky6669:

<font face='Segoe UI, Courier New, Lucida Grande, Verdana, Helvetica, sans-serif'>

<font size='3' weight='normal'>Changes the operation of various AutoIt functions/parameters.</font>

<font face='Courier New'><div id='Syntax' style='background-color:#FFFFAA;'>

:AutoItSetOption ( "option" [, param] )

</div></font>

===<font size=4><div id='Section' style='color:#DB7100;'>Parameters</div></font>===
{| class='wikitable'
|-
| option || The option to change. See Remarks.
|-
| param || '''[optional]''' The value to assign to the option. The type and meaning vary by option. See remarks below. If the param is not provided, then the function just returns the value already assigned to the option. The keyword [http://www.autoitscript.com/autoit3/docs/keywords/Default.htm Default] can be used for the parameter to reset the option to its default value.
|}

===<font size=4><div id='Section' style='color:#DB7100;'>Return Value</div></font>===
{| class='wikitable'
| Success: || Returns the value of the previous setting for the option.
|-
| Failure: || Sets @error to non-zero. Failure will occur if the parameters are invalid (such as an option that doesn't exist).
|}

===<font size=4><div id='Section' style='color:#DB7100;'>Remarks</div></font>===
You may use [[Opt]] as an alternative to [[AutoItSetOption]].

Options are as follows:
{| class='wikitable'
|-
| '''Option''' || '''Param'''
|-
| CaretCoordMode || Sets the way coords are used in the caret functions, either absolute coords or coords relative to the current active window:

0 = relative coords to the active window

1 = absolute screen coordinates (default)

2 = relative coords to the client area of the active window
|-
| ExpandEnvStrings || Changes how literal strings and % symbols are interpreted. By default strings are treated literally, this option allows you to use %environment% variables inside strings, e.g., "The temp directory is: %temp%".

0 = do not expand environment variables (default)

1 = expand environment variables

Without this option the usual way would be: "The temp directory is: " & [[EnvGet]]("temp")
|-
| ExpandVarStrings || Changes how literal strings and variable/macro ($ and @) symbols are interpreted. By default strings are treated literally, this option allows you to use variables and macros inside strings, e.g., "The value of var1 is $var1$".

0 = do not expand variables (default)

1 = expand variables (when in this mode and you want to use a literal $ or @ then double it up: "This is a single dollar $$ sign".
|-
| GUICloseOnESC || When ESC is pressed on a GUI the $GUI_EVENT_CLOSE message is sent. This option toggles this behavior on and off.

0 = Don't send the $GUI_EVENT_CLOSE message when ESC is pressed.

1 = [[Send]] the $GUI_EVENT_CLOSE message when ESC is pressed (default).
|-
| GUICoordMode || Alters the position of a control defined by [[GUICtrlSetPos]].

0 = relative position to the start of the last control (upper left corner).

1 = absolute coordinates (default) still relative to the dialog box.

2 = cell positioning relative to current cell. A -1 for left or top parameter don't increment the start.

So next line is -1, offset; next cell is offset,-1; current cell is -1,-1.

Obviously "offset" cannot be -1 which reserved to indicate the no increment. But if you can use a multiple of the width you choose to skip or go back.
|-
| GUIDataSeparatorChar || Define the character which delimits subitems in [[GUICtrlSetData]].

The default character is '<nowiki>|</nowiki>'.
|-
| GUIOnEventMode || Enable/disable OnEvent functions notifications.

0 = (default) disable.

1 = enable.
|-
| GUIResizeMode || Change default resizing for a control.

0 = (default) keep default control resizing.

<1024 = any type of resizing see [[GUICtrlSetResizing]].
|-
| GUIEventOptions || Change special event behavior or GUI function return values.

0 = (default) Windows behavior on click on Minimize,Restore, Maximize, Resize.

1 = suppress windows behavior on minimize, restore or maximize click button or window resize. Just sends the notification.
|-
| MouseClickDelay || Alters the length of the brief pause in between mouse clicks.

Time in milliseconds to pause (default=10).
|-
| MouseClickDownDelay || Alters the length a click is held down before release.

Time in milliseconds to pause (default=10).
|-
| MouseClickDragDelay || Alters the length of the brief pause at the start and end of a mouse drag operation.

Time in milliseconds to pause (default=250).
|-
| MouseCoordMode || Sets the way coords are used in the mouse functions, either absolute coords or coords relative to the current active window:

0 = relative coords to the active window

1 = absolute screen coordinates (default)

2 = relative coords to the client area of the active window
|-
| MustDeclareVars || If this option is used then all variables must be pre-declared with Local, Global or in some cases Dim before they can be used - removes the chance for misspelled variables causing bugs.

0 = Variables don't need to be pre-declared (default)

1 = Variables must be pre-declared. See [http://www.autoitscript.com/autoit3/docs/keywords/Dim.htm Dim / Global / Local / Const] for details on declaring variables.
|-
| PixelCoordMode || Sets the way coords are used in the pixel functions, either absolute coords or coords relative to the window defined by hwnd (default active window):

0 = relative coords to the defined window

1 = absolute screen coordinates (default)

2 = relative coords to the client area of the defined window
|-
| SendAttachMode || Specifies if AutoIt attaches input threads when using [[Send]] function. When not attaching (default mode=0) detecting the state of capslock/scrolllock and numlock can be unreliable under NT4. However, when you specify attach mode=1 the [[Send]]("{... down/up}") syntax will not work and there may be problems with sending keys to "hung" windows. [[ControlSend]] ALWAYS attaches and is not affected by this mode.

0 = don't attach (default)

1 = attach
|-
| SendCapslockMode || Specifies if AutoIt should store the state of capslock before a [[Send]] function and restore it afterwards.

0 = don't store/restore

1 = store and restore (default)
|-
| SendKeyDelay || Alters the length of the brief pause in between sent keystrokes. A value of 0 removes the delay completely.

Time in milliseconds to pause (default=5).
|-
| SendKeyDownDelay || Alters the length of time a key is held down before being released during a keystroke. For applications that take a while to register keypresses you may need to raise this value from the default. A value of 0 removes the delay completely.

Time in milliseconds to pause (default=5).
|-
| TCPTimeout || Defines the time before TCP functions stop if no communication.

Time in milliseconds before timeout (default=100).
|-
| TrayAutoPause || Script pauses when click on tray icon.

0 = no pause

1 = pause (default). If there is no DefaultMenu no pause will occurs.
|-
| TrayIconDebug || If enabled shows the current script line in the tray icon tip to help debugging.

0 = no debug information (default)

1 = show debug
|-
| TrayIconHide || Hides the AutoIt tray icon. Note: The icon will still initially appear ~750 milliseconds.

0 = show icon (default)

1 = hide icon
|-
| TrayMenuMode || Extend the behaviour of the script tray icon/menu. This can be done with a combination (adding) of the following values.

0 = default menu items (Script Paused/Exit) are appended to the usercreated menu; usercreated checked items will automatically unchecked; if you double click the tray icon then the controlid is returned which has the "Default"-style (default).

1 = no default menu

2 = user created checked items will not automatically unchecked if you click it

4 = don't return the menuitemID which has the "default"-style in the main contextmenu if you double click the tray icon

8 = turn off auto check of radio item groups
|-
| TrayOnEventMode || Enable/disable OnEvent functions notifications for the tray.

0 = (default) disable

1 = enable
|-
| WinDetectHiddenText || Specifies if hidden window text can be "seen" by the window matching functions.

0 = Do not detect hidden text (default)

1 = Detect hidden text
|-
| WinSearchChildren || Allows the window search routines to search child windows as well as top-level windows.

0 = Only search top-level windows (default)

1 = Search top-level and child windows
|-
| WinTextMatchMode || Alters the method that is used to match window text during search operations.

1 = Complete / Slow mode (default)

2 = Quick mode

In quick mode AutoIt can usually only "see" dialog text, button text and the captions of some controls. In the default mode much more text can be seen (for instance the contents of the Notepad window).

If you are having performance problems when performing many window searches then changing to the "quick" mode may help.
|-
| WinTitleMatchMode || Alters the method that is used to match window titles during search operations.

1 = Match the title from the start (default)

2 = Match any substring in the title

3 = Exact title match

4 = Advanced mode, see [http://www.autoitscript.com/autoit3/docs/intro/windowsadvanced.htm Window Titles & Text (Advanced)]

-1 to -4 = Case insensitive match according to the other type of match.
|-
| WinWaitDelay || Alters how long a script should briefly pause after a successful window-related operation.

Time in milliseconds to pause (default=250).
|}

===<font size=4><div id='Section' style='color:#DB7100;'>Example</div></font>===
<syntaxhighlight lang='autoit'>
; copy any you want to change ;default value is listed first

Opt("CaretCoordMode", 1) ;1=absolute, 0=relative, 2=client
Opt("ExpandEnvStrings", 0) ;0=don't expand, 1=do expand
Opt("ExpandVarStrings", 0) ;0=don't expand, 1=do expand
Opt("GUICloseOnESC", 1) ;1=ESC closes, 0=ESC won't close
Opt("GUICoordMode", 1) ;1=absolute, 0=relative, 2=cell
Opt("GUIDataSeparatorChar", "|") ;"|" is the default
Opt("GUIOnEventMode", 0) ;0=disabled, 1=OnEvent mode enabled
Opt("GUIResizeMode", 0) ;0=no resizing, <1024 special resizing
Opt("GUIEventOptions", 0) ;0=default, 1=just notification, 2=GUICtrlRead tab index
Opt("MouseClickDelay", 10) ;10 milliseconds
Opt("MouseClickDownDelay", 10) ;10 milliseconds
Opt("MouseClickDragDelay", 250) ;250 milliseconds
Opt("MouseCoordMode", 1) ;1=absolute, 0=relative, 2=client
Opt("MustDeclareVars", 0) ;0=no, 1=require pre-declaration
Opt("PixelCoordMode", 1) ;1=absolute, 0=relative, 2=client
Opt("SendAttachMode", 0) ;0=don't attach, 1=do attach
Opt("SendCapslockMode", 1) ;1=store and restore, 0=don't
Opt("SendKeyDelay", 5) ;5 milliseconds
Opt("SendKeyDownDelay", 1) ;1 millisecond
Opt("TCPTimeout", 100) ;100 milliseconds
Opt("TrayAutoPause", 1) ;0=no pause, 1=Pause
Opt("TrayIconDebug", 0) ;0=no info, 1=debug line info
Opt("TrayIconHide", 0) ;0=show, 1=hide tray icon
Opt("TrayMenuMode", 0) ;0=append, 1=no default menu, 2=no automatic check, 4=menuitemID not return
Opt("TrayOnEventMode", 0) ;0=disable, 1=enable
Opt("WinDetectHiddenText", 0) ;0=don't detect, 1=do detect
Opt("WinSearchChildren", 1) ;0=no, 1=search children also
Opt("WinTextMatchMode", 1) ;1=complete, 2=quick
Opt("WinTitleMatchMode", 1) ;1=start, 2=subStr, 3=exact, 4=advanced, -1 to -4=Nocase
Opt("WinWaitDelay", 250) ;250 milliseconds
</syntaxhighlight>
</font>
__NOTOC__
__NOEDITSECTION__

AutoItSetOption

2013-08-24T20:40:05Z

Jaberwocky6669:

<font face='Segoe UI, Courier New, Lucida Grande, Verdana, Helvetica, sans-serif'>

<font size='3' weight='normal'>Changes the operation of various AutoIt functions/parameters.</font>

<font face='Courier New'><div id='Syntax' style='background-color:#FFFFAA;'>

:AutoItSetOption ( "option" [, param] )

</div></font>

===<font size=4><div id='Section' style='color:#DB7100;'>Parameters</div></font>===
{| class='wikitable'
|-
| option || The option to change. See Remarks.
|-
| param || '''[optional]''' The value to assign to the option. The type and meaning vary by option. See remarks below. If the param is not provided, then the function just returns the value already assigned to the option. The keyword [http://www.autoitscript.com/autoit3/docs/keywords/Default.htm Default] can be used for the parameter to reset the option to its default value.
|}

===<font size=4><div id='Section' style='color:#DB7100;'>Return Value</div></font>===
{| class='wikitable'
| Success: || Returns the value of the previous setting for the option.
|-
| Failure: || Sets @error to non-zero. Failure will occur if the parameters are invalid (such as an option that doesn't exist).
|}

===<font size=4><div id='Section' style='color:#DB7100;'>Remarks</div></font>===
You may use [[Opt]] as an alternative to [[AutoItSetOption]].

Options are as follows:
{| class='wikitable'
|-
| '''Option''' || '''Param'''
|-
| CaretCoordMode || Sets the way coords are used in the caret functions, either absolute coords or coords relative to the current active window:
0 = relative coords to the active window
1 = absolute screen coordinates (default)
2 = relative coords to the client area of the active window
|-
| ExpandEnvStrings || Changes how literal strings and % symbols are interpreted. By default strings are treated literally, this option allows you to use %environment% variables inside strings, e.g., "The temp directory is: %temp%".
0 = do not expand environment variables (default)
1 = expand environment variables
Without this option the usual way would be: "The temp directory is: " & [[EnvGet]]("temp")
|-
| ExpandVarStrings || Changes how literal strings and variable/macro ($ and @) symbols are interpreted. By default strings are treated literally, this option allows you to use variables and macros inside strings, e.g., "The value of var1 is $var1$".
0 = do not expand variables (default)
1 = expand variables (when in this mode and you want to use a literal $ or @ then double it up: "This is a single dollar $$ sign".
|-
| GUICloseOnESC || When ESC is pressed on a GUI the $GUI_EVENT_CLOSE message is sent. This option toggles this behavior on and off.
0 = Don't send the $GUI_EVENT_CLOSE message when ESC is pressed.
1 = [[Send]] the $GUI_EVENT_CLOSE message when ESC is pressed (default).
|-
| GUICoordMode || Alters the position of a control defined by [[GUICtrlSetPos]].
0 = relative position to the start of the last control (upper left corner).
1 = absolute coordinates (default) still relative to the dialog box.
2 = cell positioning relative to current cell. A -1 for left or top parameter don't increment the start.
So next line is -1, offset; next cell is offset,-1; current cell is -1,-1.
Obviously "offset" cannot be -1 which reserved to indicate the no increment. But if you can use a multiple of the width you choose to skip or go back.
|-
| GUIDataSeparatorChar || Define the character which delimits subitems in [[GUICtrlSetData]].
The default character is '<nowiki>|</nowiki>'.
|-
| GUIOnEventMode || Enable/disable OnEvent functions notifications.
0 = (default) disable.
1 = enable.
|-
| GUIResizeMode || Change default resizing for a control.
0 = (default) keep default control resizing.
<1024 = any type of resizing see [[GUICtrlSetResizing]].
|-
| GUIEventOptions || Change special event behavior or GUI function return values.
0 = (default) Windows behavior on click on Minimize,Restore, Maximize, Resize.
1 = suppress windows behavior on minimize, restore or maximize click button or window resize. Just sends the notification.
|-
| MouseClickDelay || Alters the length of the brief pause in between mouse clicks.
Time in milliseconds to pause (default=10).
|-
| MouseClickDownDelay || Alters the length a click is held down before release.
Time in milliseconds to pause (default=10).
|-
| MouseClickDragDelay || Alters the length of the brief pause at the start and end of a mouse drag operation.
Time in milliseconds to pause (default=250).
|-
| MouseCoordMode || Sets the way coords are used in the mouse functions, either absolute coords or coords relative to the current active window:
0 = relative coords to the active window
1 = absolute screen coordinates (default)
2 = relative coords to the client area of the active window
|-
| MustDeclareVars || If this option is used then all variables must be pre-declared with Local, Global or in some cases Dim before they can be used - removes the chance for misspelled variables causing bugs.
0 = Variables don't need to be pre-declared (default)
1 = Variables must be pre-declared. See [http://www.autoitscript.com/autoit3/docs/keywords/Dim.htm Dim / Global / Local / Const] for details on declaring variables.
|-
| PixelCoordMode || Sets the way coords are used in the pixel functions, either absolute coords or coords relative to the window defined by hwnd (default active window):
0 = relative coords to the defined window
1 = absolute screen coordinates (default)
2 = relative coords to the client area of the defined window
|-
| SendAttachMode || Specifies if AutoIt attaches input threads when using [[Send]] function. When not attaching (default mode=0) detecting the state of capslock/scrolllock and numlock can be unreliable under NT4. However, when you specify attach mode=1 the [[Send]]("{... down/up}") syntax will not work and there may be problems with sending keys to "hung" windows. [[ControlSend]] ALWAYS attaches and is not affected by this mode.
0 = don't attach (default)
1 = attach
|-
| SendCapslockMode || Specifies if AutoIt should store the state of capslock before a [[Send]] function and restore it afterwards.
0 = don't store/restore
1 = store and restore (default)
|-
| SendKeyDelay || Alters the length of the brief pause in between sent keystrokes. A value of 0 removes the delay completely.
Time in milliseconds to pause (default=5).
|-
| SendKeyDownDelay || Alters the length of time a key is held down before being released during a keystroke. For applications that take a while to register keypresses you may need to raise this value from the default. A value of 0 removes the delay completely.
Time in milliseconds to pause (default=5).
|-
| TCPTimeout || Defines the time before TCP functions stop if no communication.
Time in milliseconds before timeout (default=100).
|-
| TrayAutoPause || Script pauses when click on tray icon.
0 = no pause
1 = pause (default). If there is no DefaultMenu no pause will occurs.
|-
| TrayIconDebug || If enabled shows the current script line in the tray icon tip to help debugging.
0 = no debug information (default)
1 = show debug
|-
| TrayIconHide || Hides the AutoIt tray icon. Note: The icon will still initially appear ~750 milliseconds.
0 = show icon (default)
1 = hide icon
|-
| TrayMenuMode || Extend the behaviour of the script tray icon/menu. This can be done with a combination (adding) of the following values.
0 = default menu items (Script Paused/Exit) are appended to the usercreated menu; usercreated checked items will automatically unchecked; if you double click the tray icon then the controlid is returned which has the "Default"-style (default).
1 = no default menu
2 = user created checked items will not automatically unchecked if you click it
4 = don't return the menuitemID which has the "default"-style in the main contextmenu if you double click the tray icon
8 = turn off auto check of radio item groups
|-
| TrayOnEventMode || Enable/disable OnEvent functions notifications for the tray.
0 = (default) disable
1 = enable
|-
| WinDetectHiddenText || Specifies if hidden window text can be "seen" by the window matching functions.
0 = Do not detect hidden text (default)
1 = Detect hidden text
|-
| WinSearchChildren || Allows the window search routines to search child windows as well as top-level windows.
0 = Only search top-level windows (default)
1 = Search top-level and child windows
|-
| WinTextMatchMode || Alters the method that is used to match window text during search operations.
1 = Complete / Slow mode (default)
2 = Quick mode
In quick mode AutoIt can usually only "see" dialog text, button text and the captions of some controls. In the default mode much more text can be seen (for instance the contents of the Notepad window).
If you are having performance problems when performing many window searches then changing to the "quick" mode may help.
|-
| WinTitleMatchMode || Alters the method that is used to match window titles during search operations.
1 = Match the title from the start (default)
2 = Match any substring in the title
3 = Exact title match
4 = Advanced mode, see [http://www.autoitscript.com/autoit3/docs/intro/windowsadvanced.htm Window Titles & Text (Advanced)]
-1 to -4 = Case insensitive match according to the other type of match.
|-
| WinWaitDelay || Alters how long a script should briefly pause after a successful window-related operation.
Time in milliseconds to pause (default=250).
|}

===<font size=4><div id='Section' style='color:#DB7100;'>Example</div></font>===
<syntaxhighlight lang='autoit'>
; copy any you want to change ;default value is listed first

Opt("CaretCoordMode", 1) ;1=absolute, 0=relative, 2=client
Opt("ExpandEnvStrings", 0) ;0=don't expand, 1=do expand
Opt("ExpandVarStrings", 0) ;0=don't expand, 1=do expand
Opt("GUICloseOnESC", 1) ;1=ESC closes, 0=ESC won't close
Opt("GUICoordMode", 1) ;1=absolute, 0=relative, 2=cell
Opt("GUIDataSeparatorChar", "|") ;"|" is the default
Opt("GUIOnEventMode", 0) ;0=disabled, 1=OnEvent mode enabled
Opt("GUIResizeMode", 0) ;0=no resizing, <1024 special resizing
Opt("GUIEventOptions", 0) ;0=default, 1=just notification, 2=GUICtrlRead tab index
Opt("MouseClickDelay", 10) ;10 milliseconds
Opt("MouseClickDownDelay", 10) ;10 milliseconds
Opt("MouseClickDragDelay", 250) ;250 milliseconds
Opt("MouseCoordMode", 1) ;1=absolute, 0=relative, 2=client
Opt("MustDeclareVars", 0) ;0=no, 1=require pre-declaration
Opt("PixelCoordMode", 1) ;1=absolute, 0=relative, 2=client
Opt("SendAttachMode", 0) ;0=don't attach, 1=do attach
Opt("SendCapslockMode", 1) ;1=store and restore, 0=don't
Opt("SendKeyDelay", 5) ;5 milliseconds
Opt("SendKeyDownDelay", 1) ;1 millisecond
Opt("TCPTimeout", 100) ;100 milliseconds
Opt("TrayAutoPause", 1) ;0=no pause, 1=Pause
Opt("TrayIconDebug", 0) ;0=no info, 1=debug line info
Opt("TrayIconHide", 0) ;0=show, 1=hide tray icon
Opt("TrayMenuMode", 0) ;0=append, 1=no default menu, 2=no automatic check, 4=menuitemID not return
Opt("TrayOnEventMode", 0) ;0=disable, 1=enable
Opt("WinDetectHiddenText", 0) ;0=don't detect, 1=do detect
Opt("WinSearchChildren", 1) ;0=no, 1=search children also
Opt("WinTextMatchMode", 1) ;1=complete, 2=quick
Opt("WinTitleMatchMode", 1) ;1=start, 2=subStr, 3=exact, 4=advanced, -1 to -4=Nocase
Opt("WinWaitDelay", 250) ;250 milliseconds
</syntaxhighlight>
</font>
__NOTOC__
__NOEDITSECTION__

AutoItSetOption

2013-08-24T19:26:52Z

Jaberwocky6669:

<font face='Segoe UI, Courier New, Lucida Grande, Verdana, Helvetica, sans-serif'>

<font size='3' weight='normal'>Changes the operation of various AutoIt functions/parameters.</font>

<font face='Courier New'><div id='Syntax' style='background-color:#FFFFAA;'>

:AutoItSetOption ( "option" [, param] )

</div></font>

===<font size=4><div id='Section' style='color:#DB7100;'>Parameters</div></font>===
{| class='wikitable'
|-
| option || The option to change. See Remarks.
|-
| param || '''[optional]''' The value to assign to the option. The type and meaning vary by option. See remarks below. If the param is not provided, then the function just returns the value already assigned to the option. The keyword [http://www.autoitscript.com/autoit3/docs/keywords/Default.htm Default] can be used for the parameter to reset the option to its default value.
|}

===<font size=4><div id='Section' style='color:#DB7100;'>Return Value</div></font>===
{| class='wikitable'
| Success: || Returns the value of the previous setting for the option.
|-
| Failure: || Sets @error to non-zero. Failure will occur if the parameters are invalid (such as an option that doesn't exist).
|}

===<font size=4><div id='Section' style='color:#DB7100;'>Remarks</div></font>===
You may use [[Opt]] as an alternative to [[AutoItSetOption]].

Options are as follows:
{| class='wikitable'
|-
| '''Option''' || '''Param'''
|-
| CaretCoordMode || Sets the way coords are used in the caret functions, either absolute coords or coords relative to the current active window:
|-
| || 0 = relative coords to the active window
|-
| || 1 = absolute screen coordinates (default)
|-
| || 2 = relative coords to the client area of the active window
|-
| ExpandEnvStrings || Changes how literal strings and % symbols are interpreted. By default strings are treated literally, this option allows you to use %environment% variables inside strings, e.g., "The temp directory is: %temp%".
|-
| || 0 = do not expand environment variables (default)
|-
| || 1 = expand environment variables
|-
| || Without this option the usual way would be: "The temp directory is: " & [[EnvGet]]("temp")
|-
| ExpandVarStrings || Changes how literal strings and variable/macro ($ and @) symbols are interpreted. By default strings are treated literally, this option allows you to use variables and macros inside strings, e.g., "The value of var1 is $var1$".
|-
| || 0 = do not expand variables (default)
|-
| || 1 = expand variables (when in this mode and you want to use a literal $ or @ then double it up: "This is a single dollar $$ sign".
|-
| GUICloseOnESC || When ESC is pressed on a GUI the $GUI_EVENT_CLOSE message is sent. This option toggles this behavior on and off.
|-
| || 0 = Don't send the $GUI_EVENT_CLOSE message when ESC is pressed.
|-
| || 1 = [[Send]] the $GUI_EVENT_CLOSE message when ESC is pressed (default).
|-
| GUICoordMode || Alters the position of a control defined by [[GUICtrlSetPos]].
|-
| || 0 = relative position to the start of the last control (upper left corner).
|-
| || 1 = absolute coordinates (default) still relative to the dialog box.
|-
| || 2 = cell positioning relative to current cell. A -1 for left or top parameter don't increment the start.
|-
| || So next line is -1, offset; next cell is offset,-1; current cell is -1,-1.
|-
| || Obviously "offset" cannot be -1 which reserved to indicate the no increment. But if you can use a multiple of the width you choose to skip or go back.
|-
| GUIDataSeparatorChar || Define the character which delimits subitems in [[GUICtrlSetData]].
|-
| || The default character is '<nowiki>|</nowiki>'.
|-
| GUIOnEventMode || Enable/disable OnEvent functions notifications.
|-
| || 0 = (default) disable.
|-
| || 1 = enable.
|-
| GUIResizeMode || Change default resizing for a control.
|-
| || 0 = (default) keep default control resizing.
|-
| || <1024 = any type of resizing see [[GUICtrlSetResizing]].
|-
| GUIEventOptions || Change special event behavior or GUI function return values.
|-
| || 0 = (default) Windows behavior on click on Minimize,Restore, Maximize, Resize.
|-
| || 1 = suppress windows behavior on minimize, restore or maximize click button or window resize. Just sends the notification.
|-
| MouseClickDelay || Alters the length of the brief pause in between mouse clicks.
|-
| || Time in milliseconds to pause (default=10).
|-
| MouseClickDownDelay || Alters the length a click is held down before release.
|-
| || Time in milliseconds to pause (default=10).
|-
| MouseClickDragDelay || Alters the length of the brief pause at the start and end of a mouse drag operation.
|-
| || Time in milliseconds to pause (default=250).
|-
| MouseCoordMode || Sets the way coords are used in the mouse functions, either absolute coords or coords relative to the current active window:
|-
| || 0 = relative coords to the active window
|-
| || 1 = absolute screen coordinates (default)
|-
| || 2 = relative coords to the client area of the active window
|-
| MustDeclareVars || If this option is used then all variables must be pre-declared with Local, Global or in some cases Dim before they can be used - removes the chance for misspelled variables causing bugs.
|-
| || 0 = Variables don't need to be pre-declared (default)
|-
| || 1 = Variables must be pre-declared. See [http://www.autoitscript.com/autoit3/docs/keywords/Dim.htm Dim / Global / Local / Const] for details on declaring variables.
|-
| PixelCoordMode || Sets the way coords are used in the pixel functions, either absolute coords or coords relative to the window defined by hwnd (default active window):
|-
| || 0 = relative coords to the defined window
|-
| || 1 = absolute screen coordinates (default)
|-
| || 2 = relative coords to the client area of the defined window
|-
| SendAttachMode || Specifies if AutoIt attaches input threads when using [[Send]] function. When not attaching (default mode=0) detecting the state of capslock/scrolllock and numlock can be unreliable under NT4. However, when you specify attach mode=1 the [[Send]]("{... down/up}") syntax will not work and there may be problems with sending keys to "hung" windows. [[ControlSend]] ALWAYS attaches and is not affected by this mode.
|-
| || 0 = don't attach (default)
|-
| || 1 = attach
|-
| SendCapslockMode || Specifies if AutoIt should store the state of capslock before a [[Send]] function and restore it afterwards.
|-
| || 0 = don't store/restore
|-
| || 1 = store and restore (default)
|-
| SendKeyDelay || Alters the length of the brief pause in between sent keystrokes. A value of 0 removes the delay completely.
|-
| || Time in milliseconds to pause (default=5).
|-
| SendKeyDownDelay || Alters the length of time a key is held down before being released during a keystroke. For applications that take a while to register keypresses you may need to raise this value from the default. A value of 0 removes the delay completely.
|-
| || Time in milliseconds to pause (default=5).
|-
| TCPTimeout || Defines the time before TCP functions stop if no communication.
|-
| || Time in milliseconds before timeout (default=100).
|-
| TrayAutoPause || Script pauses when click on tray icon.
|-
| || 0 = no pause
|-
| || 1 = pause (default). If there is no DefaultMenu no pause will occurs.
|-
| TrayIconDebug || If enabled shows the current script line in the tray icon tip to help debugging.
|-
| || 0 = no debug information (default)
|-
| || 1 = show debug
|-
| TrayIconHide || Hides the AutoIt tray icon. Note: The icon will still initially appear ~750 milliseconds.
|-
| || 0 = show icon (default)
|-
| || 1 = hide icon
|-
| TrayMenuMode || Extend the behaviour of the script tray icon/menu. This can be done with a combination (adding) of the following values.
|-
| || 0 = default menu items (Script Paused/Exit) are appended to the usercreated menu; usercreated checked items will automatically unchecked; if you double click the tray icon then the controlid is returned which has the "Default"-style (default).
|-
| || 1 = no default menu
|-
| || 2 = user created checked items will not automatically unchecked if you click it
|-
| || 4 = don't return the menuitemID which has the "default"-style in the main contextmenu if you double click the tray icon
|-
| || 8 = turn off auto check of radio item groups
|-
| TrayOnEventMode || Enable/disable OnEvent functions notifications for the tray.
|-
| || 0 = (default) disable
|-
| || 1 = enable
|-
| WinDetectHiddenText || Specifies if hidden window text can be "seen" by the window matching functions.
|-
| || 0 = Do not detect hidden text (default)
|-
| || 1 = Detect hidden text
|-
| WinSearchChildren || Allows the window search routines to search child windows as well as top-level windows.
|-
| || 0 = Only search top-level windows (default)
|-
| || 1 = Search top-level and child windows
|-
| WinTextMatchMode || Alters the method that is used to match window text during search operations.
|-
| || 1 = Complete / Slow mode (default)
|-
| || 2 = Quick mode
|-
| || In quick mode AutoIt can usually only "see" dialog text, button text and the captions of some controls. In the default mode much more text can be seen (for instance the contents of the Notepad window).
|-
| || If you are having performance problems when performing many window searches then changing to the "quick" mode may help.
|-
| WinTitleMatchMode || Alters the method that is used to match window titles during search operations.
|-
| || 1 = Match the title from the start (default)
|-
| || 2 = Match any substring in the title
|-
| || 3 = Exact title match
|-
| || 4 = Advanced mode, see [http://www.autoitscript.com/autoit3/docs/intro/windowsadvanced.htm Window Titles & Text (Advanced)]
|-
| || -1 to -4 = Case insensitive match according to the other type of match.
|-
| WinWaitDelay || Alters how long a script should briefly pause after a successful window-related operation.
|-
| || Time in milliseconds to pause (default=250).
|}

===<font size=4><div id='Section' style='color:#DB7100;'>Example</div></font>===
<syntaxhighlight lang='autoit'>
; copy any you want to change ;default value is listed first

Opt("CaretCoordMode", 1) ;1=absolute, 0=relative, 2=client
Opt("ExpandEnvStrings", 0) ;0=don't expand, 1=do expand
Opt("ExpandVarStrings", 0) ;0=don't expand, 1=do expand
Opt("GUICloseOnESC", 1) ;1=ESC closes, 0=ESC won't close
Opt("GUICoordMode", 1) ;1=absolute, 0=relative, 2=cell
Opt("GUIDataSeparatorChar", "|") ;"|" is the default
Opt("GUIOnEventMode", 0) ;0=disabled, 1=OnEvent mode enabled
Opt("GUIResizeMode", 0) ;0=no resizing, <1024 special resizing
Opt("GUIEventOptions", 0) ;0=default, 1=just notification, 2=GUICtrlRead tab index
Opt("MouseClickDelay", 10) ;10 milliseconds
Opt("MouseClickDownDelay", 10) ;10 milliseconds
Opt("MouseClickDragDelay", 250) ;250 milliseconds
Opt("MouseCoordMode", 1) ;1=absolute, 0=relative, 2=client
Opt("MustDeclareVars", 0) ;0=no, 1=require pre-declaration
Opt("PixelCoordMode", 1) ;1=absolute, 0=relative, 2=client
Opt("SendAttachMode", 0) ;0=don't attach, 1=do attach
Opt("SendCapslockMode", 1) ;1=store and restore, 0=don't
Opt("SendKeyDelay", 5) ;5 milliseconds
Opt("SendKeyDownDelay", 1) ;1 millisecond
Opt("TCPTimeout", 100) ;100 milliseconds
Opt("TrayAutoPause", 1) ;0=no pause, 1=Pause
Opt("TrayIconDebug", 0) ;0=no info, 1=debug line info
Opt("TrayIconHide", 0) ;0=show, 1=hide tray icon
Opt("TrayMenuMode", 0) ;0=append, 1=no default menu, 2=no automatic check, 4=menuitemID not return
Opt("TrayOnEventMode", 0) ;0=disable, 1=enable
Opt("WinDetectHiddenText", 0) ;0=don't detect, 1=do detect
Opt("WinSearchChildren", 1) ;0=no, 1=search children also
Opt("WinTextMatchMode", 1) ;1=complete, 2=quick
Opt("WinTitleMatchMode", 1) ;1=start, 2=subStr, 3=exact, 4=advanced, -1 to -4=Nocase
Opt("WinWaitDelay", 250) ;250 milliseconds
</syntaxhighlight>
</font>
__NOTOC__
__NOEDITSECTION__

GUICreate

2013-08-23T16:16:08Z

Jaberwocky6669:

ControlTreeView

2013-08-23T16:15:23Z

Jaberwocky6669:

StringSplit

2013-08-23T16:14:43Z

Jaberwocky6669:

GUIRegisterMsg

2013-08-23T16:13:54Z

Jaberwocky6669:

<font face='Segoe UI, Courier New, Lucida Grande, Verdana, Helvetica, sans-serif'>

<font size='3' weight='normal'>Register a user defined function for a known Windows Message ID (WM_MSG).</font>

<font face='Courier New'><div id='Syntax' style='background-color:#FFFFAA;'>

:GUIRegisterMsg ( msgID, "function" )

</div></font>

===<font size=4><div id='Section' style='color:#DB7100;'>Parameters</div></font>===
{| class='wikitable'
|-
| msgID || A Windows Message ID (see Appendix: [http://www.autoitscript.com/autoit3/docs/appendix/WinMsgCodes.htm Windows Message Codes]).
|-
| function || The name of the user function to call when the message appears or an empty string "" to unregister a message.
|}

===<font size=4><div id='Section' style='color:#DB7100;'>Return Value</div></font>===
{| class='wikitable'
| Success: || 1
|-
| Failure: || 0
|}

===<font size=4><div id='Section' style='color:#DB7100;'>Remarks</div></font>===
To make the user function workable you have to define it with '''maximum 4 function parameters''' otherwise the function won't be called!

i.e:
Func MyUserFunction($hWndGUI, $MsgID, $WParam, $LParam)
...
EndFunc

Or

Func MyUserFunction($hWndGUI, $MsgID)
...
EndFunc

When the user function is called then these 4 parameters have the following values:

{| class='wikitable'
! | '''Position'''
! | '''Parameter'''
! | '''Meaning'''
|-
| 1 || hWnd || The Window handle of the GUI in which the message appears.
|-
| 2 || Msg || The Windows message ID.
|-
| 3 || wParam || The first message parameter as hex value.
|-
| 4 || lParam || The second message parameter as hex value.
|}

Up to 256 user functions can be registered for message IDs.

By default after finishing the user function the AutoIt internal message handler will be proceed.
That won't be if your '''Return''' a value (See WM_COMMAND in example) or if you use the keyword 'Return' without any value.
By using 'Return' without any return value the AutoIt internal message handler (if there is one for this message) will NOT be proceed!

If you want AutoIt to run its internal handler for a message, return the variable '''$GUI_RUNDEFMSG''' (in GUIConstantsEx.au3) from the function (see also examples)!

I.e. if you want to return earlier than the user function ends and also proceed the AutoIt internal message handler.

'''Warning:''' blocking of running user functions which executes window messages with commands such as "[[MsgBox]]" can lead to unexpected behavior, the return to the system should be as fast as possible!

Some controls consume internally specific Windows Message ID, so registering them will have no effect, e.g; WM_CHAR, WM_KEYDOWN, WM_KEYUP are consumed by an edit control.

===<font size=4><div id='Section' style='color:#DB7100;'>Related</div></font>===
[[GUICtrlGetHandle]]

===<font size=4><div id='Section' style='color:#DB7100;'>Example</div></font>===
<syntaxhighlight lang='autoit'>
; Create an ownerdrawn/colored button

#include <GUIConstantsEx.au3>
#include <WindowsConstants.au3>
#include <ButtonConstants.au3>
#include <MsgBoxConstants.au3>

Example()

Func Example()
Local Const $BS_OWNERDRAW = 0x0000000B
Local $iButton = 0, $iButton2 = 0, $iMsg = 0

GUICreate("My Ownerdrawn Created Button", 300, 200)

$iButton = GUICtrlCreateButton("", 90, 50, 120, 30)
GUICtrlSetStyle($iButton, BitOR($WS_TABSTOP, $BS_NOTIFY, $BS_OWNERDRAW)) ; Set the ownerdrawn flag

$iButton2 = GUICtrlCreateButton("Normal Button", 90, 110, 120, 30)

GUIRegisterMsg($WM_COMMAND, "MY_WM_COMMAND")
; WM_DRAWITEM has to registered before showing GUI otherwise the initial drawing isn't done
GUIRegisterMsg($WM_DRAWITEM, "MY_WM_DRAWITEM")

GUISetState()

While 1
$iMsg = GUIGetMsg()

Switch $iMsg
Case $GUI_EVENT_CLOSE
ExitLoop

Case $iButton
; Normally should not run through cause of our MY_WM_COMMAND function
MsgBox($MB_SYSTEMMODAL, "Info", "Button pressed")

Case $iButton2
; Normally should not run through cause of our MY_WM_COMMAND function
MsgBox($MB_SYSTEMMODAL, "Info", "Button2 pressed")
EndSwitch
WEnd

GUIDelete()
EndFunc ;==>Example

; React on a button click
Func MY_WM_COMMAND($hWnd, $Msg, $wParam, $lParam)
Local $nNotifyCode = BitShift($wParam, 16)
Local $nID = BitAND($wParam, 0x0000FFFF)
Local $hCtrl = $lParam

If $nID <> 2 And $nNotifyCode = 0 Then ; Check for IDCANCEL - 2
; Ownerdrawn buttons don't send something by pressing ENTER
; So IDOK - 1 comes up, now check for the control that has the current focus
If $nID = 1 Then
Local $hFocus = DllCall("user32.dll", "hwnd", "GetFocus")
Local $nCtrlID = DllCall("user32.dll", "int", "GetDlgCtrlID", "hwnd", $hFocus[0])
PostButtonClick($hWnd, $nCtrlID[0])
Else
MsgBox($MB_SYSTEMMODAL, "MY_WM_COMMAND", "GUIHWnd" & @TAB & ":" & $hWnd & @CRLF & _
"MsgID" & @TAB & ":" & $Msg & @CRLF & _
"wParam" & @TAB & ":" & $wParam & @CRLF & _
"lParam" & @TAB & ":" & $lParam & @CRLF & @CRLF & _
"WM_COMMAND - Infos:" & @CRLF & _
"-----------------------------" & @CRLF & _
"Code" & @TAB & ":" & $nNotifyCode & @CRLF & _
"CtrlID" & @TAB & ":" & $nID & @CRLF & _
"CtrlHWnd" & @TAB & ":" & $hCtrl)
EndIf
Return 0 ; Only workout clicking on the button
EndIf
; Proceed the default AutoIt3 internal message commands.
; You also can complete let the line out.
;!
But only 'Return' (without any value) will not proceed
; the default AutoIt3-message in the future!

Return $GUI_RUNDEFMSG
EndFunc ;==>MY_WM_COMMAND

; RePost a WM_COMMAND message to a ctrl in a gui window
Func PostButtonClick($hWnd, $nCtrlID)
DllCall("user32.dll", "int", "PostMessage", _
"hwnd", $hWnd, _
"int", $WM_COMMAND, _
"int", BitAND($nCtrlID, 0x0000FFFF), _
"hwnd", GUICtrlGetHandle($nCtrlID))
EndFunc ;==>PostButtonClick

; Draw the button
Func MY_WM_DRAWITEM($hWnd, $Msg, $wParam, $lParam)
#forceref $Msg, $wParam, $lParam
Local $stDrawItem = DllStructCreate("uint;uint;uint;uint;uint;uint;uint;int[4];dword", $lParam)
Local Const $ODT_BUTTON = 4

Local $nCtlType = DllStructGetData($stDrawItem, 1)
If $nCtlType = $ODT_BUTTON Then
; Local $nCtrlID = DllStructGetData($stDrawItem, 2)
Local $nItemState = DllStructGetData($stDrawItem, 5)
Local $hCtrl = DllStructGetData($stDrawItem, 6)
Local $hDC = DllStructGetData($stDrawItem, 7)
Local $nLeft = DllStructGetData($stDrawItem, 8, 1)
Local $nTop = DllStructGetData($stDrawItem, 8, 2)
Local $nRight = DllStructGetData($stDrawItem, 8, 3)
Local $nBottom = DllStructGetData($stDrawItem, 8, 4)
Local $sText = "Ownerdrawn Button"
Local $nTextColor = 0x5555DD
Local $nBackColor = 0xFFEEDD
DrawButton($hWnd, $hCtrl, $hDC, $nLeft, $nTop, $nRight, $nBottom, $nItemState, $sText, $nTextColor, $nBackColor)
$stDrawItem = 0
Return 1
EndIf

$stDrawItem = 0
Return $GUI_RUNDEFMSG ; Proceed the default AutoIt3 internal message commands
EndFunc ;==>MY_WM_DRAWITEM

; The main drawing procedure
Func DrawButton($hWnd, $hCtrl, $hDC, $nLeft, $nTop, $nRight, $nBottom, $nItemState, $sText, $nTextColor, $nBackColor)
#forceref $hWnd
;Local $bDefault = FALSE
Local Const $GWL_STYLE = -16
Local Const $ODS_SELECTED = 0x0001
Local Const $ODS_GRAYED = 0x0002
Local Const $ODS_DISABLED = 0x0004
; Local Const $ODS_CHECKED = 0x0008
Local Const $ODS_FOCUS = 0x0010
; Local Const $ODS_HOTLIGHT = 0x0040
; Local Const $ODS_INACTIVE = 0x0080
; Local Const $ODS_NOACCEL = 0x0100
; Local Const $ODS_NOFOCUSRECT = 0x0200
Local Const $DFC_BUTTON = 4
Local Const $DFCS_BUTTONPUSH = 0x0010
; Local $bChecked = BitAND($nItemState, $ODS_CHECKED)
Local $bFocused = BitAND($nItemState, $ODS_FOCUS)
Local $bGrayed = BitAND($nItemState, BitOR($ODS_GRAYED, $ODS_DISABLED))
Local $bSelected = BitAND($nItemState, $ODS_SELECTED)

Local $stRect = DllStructCreate("int;int;int;int")
DllStructSetData($stRect, 1, $nLeft)
DllStructSetData($stRect, 2, $nTop)
DllStructSetData($stRect, 3, $nRight)
DllStructSetData($stRect, 4, $nBottom)

Local $nClrTxt
If $bGrayed Then
$nClrTxt = SetTextColor($hDC, GetSysColor($COLOR_HIGHLIGHTTEXT))
ElseIf $nTextColor = -1 Then
$nClrTxt = SetTextColor($hDC, GetSysColor($COLOR_BTNTEXT))
Else
$nClrTxt = SetTextColor($hDC, $nTextColor)
EndIf

Local $hBrush, $nClrSel
If $nBackColor = -1 Then
$hBrush = GetSysColorBrush($COLOR_BTNFACE)
$nClrSel = GetSysColor($COLOR_BTNFACE)
Else
$hBrush = CreateSolidBrush($nBackColor)
$nClrSel = $nBackColor;
EndIf

Local $nClrBk = SetBkColor($hDC, $nClrSel)
Local $hOldBrush = SelectObject($hDC, $hBrush)

Local $nTmpLeft = $nLeft
Local $nTmpTop = $nTop
Local $nTmpRight = $nRight
Local $nTmpBottom = $nBottom

If $bSelected Then
InflateRect($nTmpLeft, $nTmpTop, $nTmpRight, $nTmpBottom, -1, -1)
Local $hBrushSel = CreateSolidBrush(GetSysColor($COLOR_BTNSHADOW))
FrameRect($hDC, $nTmpLeft, $nTmpTop, $nTmpRight, $nTmpBottom, $hBrushSel)
DeleteObject($hBrushSel)
Else
If $bFocused And Not $bSelected Then InflateRect($nTmpLeft, $nTmpTop, $nTmpRight, $nTmpBottom, -1, -1)
DrawFrameControl($hDC, $nTmpLeft, $nTmpTop, $nTmpRight, $nTmpBottom, $DFC_BUTTON, $DFCS_BUTTONPUSH)
EndIf

$nTmpLeft = $nLeft
$nTmpTop = $nTop
$nTmpRight = $nRight
$nTmpBottom = $nBottom

If $bSelected Then
InflateRect($nTmpLeft, $nTmpTop, $nTmpRight, $nTmpBottom, -2, -2)
Else
If $bFocused And Not $bSelected Then
InflateRect($nTmpLeft, $nTmpTop, $nTmpRight, $nTmpBottom, -3, -3)
$nTmpLeft -= 1
$nTmpTop -= 1
Else
InflateRect($nTmpLeft, $nTmpTop, $nTmpRight, $nTmpBottom, -2, -2)
$nTmpLeft -= 1
$nTmpTop -= 1
EndIf
EndIf

FillRect($hDC, $nTmpLeft, $nTmpTop, $nTmpRight, $nTmpBottom, $hBrush)

If $bSelected Or $bGrayed Then
$nTmpLeft = $nTmpLeft + 2
$nTmpTop = $nTmpTop + 2
EndIf

Local $uFlags = BitOR($DT_NOCLIP, $DT_CENTER, $DT_VCENTER)

If Not BitAND(GetWindowLong($hCtrl, $GWL_STYLE), $BS_MULTILINE) Then $uFlags = BitOR($uFlags, $DT_SINGLELINE)

DrawText($hDC, $sText, $nTmpLeft, $nTmpTop, $nTmpRight, $nTmpBottom, $uFlags)

If $bGrayed Then
$nTmpLeft = $nLeft
$nTmpTop = $nTop
$nTmpRight = $nRight
$nTmpBottom = $nBottom

$nTmpLeft -= 1

$nClrTxt = SetTextColor($hDC, GetSysColor($COLOR_GRAYTEXT))
DrawText($hDC, $sText, $nTmpLeft, $nTmpTop, $nTmpRight, $nTmpBottom, BitOR($DT_NOCLIP, $DT_CENTER, $DT_VCENTER, $DT_SINGLELINE))
EndIf

$nTmpLeft = $nLeft
$nTmpTop = $nTop
$nTmpRight = $nRight
$nTmpBottom = $nBottom

If $bFocused Then
$hBrush = CreateSolidBrush(0)
FrameRect($hDC, $nTmpLeft, $nTmpTop, $nTmpRight, $nTmpBottom, $hBrush)

$nTmpLeft = $nLeft
$nTmpTop = $nTop
$nTmpRight = $nRight
$nTmpBottom = $nBottom

InflateRect($nTmpLeft, $nTmpTop, $nTmpRight, $nTmpBottom, -4, -4)
DrawFocusRect($hDC, $nTmpLeft, $nTmpTop, $nTmpRight, $nTmpBottom)
EndIf

SelectObject($hDC, $hOldBrush)
DeleteObject($hBrush)
SetTextColor($hDC, $nClrTxt)
SetBkColor($hDC, $nClrBk)

Return 1
EndFunc ;==>DrawButton

; Some graphic / windows functions
Func CreateSolidBrush($nColor)
Local $hBrush = DllCall("gdi32.dll", "hwnd", "CreateSolidBrush", "int", $nColor)
Return $hBrush[0]
EndFunc ;==>CreateSolidBrush

Func GetSysColor($nIndex)
Local $nColor = DllCall("user32.dll", "int", "GetSysColor", "int", $nIndex)
Return $nColor[0]
EndFunc ;==>GetSysColor

Func GetSysColorBrush($nIndex)
Local $hBrush = DllCall("user32.dll", "hwnd", "GetSysColorBrush", "int", $nIndex)
Return $hBrush[0]
EndFunc ;==>GetSysColorBrush

Func DrawFrameControl($hDC, $nLeft, $nTop, $nRight, $nBottom, $nType, $nState)
Local $stRect = DllStructCreate("int;int;int;int")

DllStructSetData($stRect, 1, $nLeft)
DllStructSetData($stRect, 2, $nTop)
DllStructSetData($stRect, 3, $nRight)
DllStructSetData($stRect, 4, $nBottom)

DllCall("user32.dll", "int", "DrawFrameControl", "hwnd", $hDC, "ptr", DllStructGetPtr($stRect), "int", $nType, "int", $nState)

$stRect = 0
EndFunc ;==>DrawFrameControl

Func DrawFocusRect($hDC, $nLeft, $nTop, $nRight, $nBottom)
Local $stRect = DllStructCreate("int;int;int;int")

DllStructSetData($stRect, 1, $nLeft)
DllStructSetData($stRect, 2, $nTop)
DllStructSetData($stRect, 3, $nRight)
DllStructSetData($stRect, 4, $nBottom)

DllCall("user32.dll", "int", "DrawFocusRect", "hwnd", $hDC, "ptr", DllStructGetPtr($stRect))

$stRect = 0
EndFunc ;==>DrawFocusRect

Func DrawText($hDC, $sText, $nLeft, $nTop, $nRight, $nBottom, $nFormat)
Local $nLen = StringLen($sText)

Local $stRect = DllStructCreate("int;int;int;int")
DllStructSetData($stRect, 1, $nLeft)
DllStructSetData($stRect, 2, $nTop)
DllStructSetData($stRect, 3, $nRight)
DllStructSetData($stRect, 4, $nBottom)

Local $stText = DllStructCreate("char[260]")
DllStructSetData($stText, 1, $sText)

DllCall("user32.dll", "int", "DrawText", "hwnd", $hDC, "ptr", DllStructGetPtr($stText), "int", $nLen, "ptr", DllStructGetPtr($stRect), "int", $nFormat)

$stRect = 0
$stText = 0
EndFunc ;==>DrawText

Func FillRect($hDC, $nLeft, $nTop, $nRight, $nBottom, $hBrush)
Local $stRect = DllStructCreate("int;int;int;int")

DllStructSetData($stRect, 1, $nLeft)
DllStructSetData($stRect, 2, $nTop)
DllStructSetData($stRect, 3, $nRight)
DllStructSetData($stRect, 4, $nBottom)

DllCall("user32.dll", "int", "FillRect", "hwnd", $hDC, "ptr", DllStructGetPtr($stRect), "hwnd", $hBrush)

$stRect = 0
EndFunc ;==>FillRect

Func FrameRect($hDC, $nLeft, $nTop, $nRight, $nBottom, $hBrush)
Local $stRect = DllStructCreate("int;int;int;int")

DllStructSetData($stRect, 1, $nLeft)
DllStructSetData($stRect, 2, $nTop)
DllStructSetData($stRect, 3, $nRight)
DllStructSetData($stRect, 4, $nBottom)

DllCall("user32.dll", "int", "FrameRect", "hwnd", $hDC, "ptr", DllStructGetPtr($stRect), "hwnd", $hBrush)

$stRect = 0
EndFunc ;==>FrameRect

Func InflateRect(ByRef $nLeft, ByRef $nTop, ByRef $nRight, ByRef $nBottom, $nX, $nY)
Local $stRect = DllStructCreate("int;int;int;int")

DllStructSetData($stRect, 1, $nLeft)
DllStructSetData($stRect, 2, $nTop)
DllStructSetData($stRect, 3, $nRight)
DllStructSetData($stRect, 4, $nBottom)

DllCall("user32.dll", "int", "InflateRect", "ptr", DllStructGetPtr($stRect), "int", $nX, "int", $nY)

$nLeft = DllStructGetData($stRect, 1)
$nTop = DllStructGetData($stRect, 2)
$nRight = DllStructGetData($stRect, 3)
$nBottom = DllStructGetData($stRect, 4)

$stRect = 0
EndFunc ;==>InflateRect

Func SetBkColor($hDC, $nColor)
Local $nOldColor = DllCall("gdi32.dll", "int", "SetBkColor", "hwnd", $hDC, "int", $nColor)
Return $nOldColor[0]
EndFunc ;==>SetBkColor

Func SetTextColor($hDC, $nColor)
Local $nOldColor = DllCall("gdi32.dll", "int", "SetTextColor", "hwnd", $hDC, "int", $nColor)
Return $nOldColor[0]
EndFunc ;==>SetTextColor

Func SelectObject($hDC, $hObj)
Local $hOldObj = DllCall("gdi32.dll", "hwnd", "SelectObject", "hwnd", $hDC, "hwnd", $hObj)
Return $hOldObj[0]
EndFunc ;==>SelectObject

Func DeleteObject($hObj)
DllCall("gdi32.dll", "hwnd", "DeleteObject", "hwnd", $hObj)
EndFunc ;==>DeleteObject

Func GetWindowLong($hWnd, $nIndex)
Local $nVal = DllCall("user32.dll", "int", "GetWindowLong", "hwnd", $hWnd, "int", $nIndex)
Return $nVal[0]
EndFunc ;==>GetWindowLong
</syntaxhighlight>
</font>
__NOTOC__
__NOEDITSECTION__

2013-08-23T04:35:09Z

User:Jaberwocky6669

2013-08-23T04:24:42Z

Jaberwocky6669:

__NOTOC__
__NOEDITSECTION__

= 2013 Version =

<center>[[Image:logo2.png]]<br>
©1999-2013 Jonathan Bennett & [[AutoIt_Team | AutoIt Team]]<br>
[http://www.autoitscript.com/autoit3/index.php AutoIt v3 Homepage]<br>
<br></center>

== Introduction ==

AutoIt v3 is a freeware BASIC-like scripting language designed for automating the Windows GUI and general scripting. It uses a combination of simulated keystrokes, mouse movement and window/control manipulation in order to automate tasks in a way not possible or reliable with other languages (e.g. VBScript and SendKeys). AutoIt is also very small, self-contained and will run on all versions of Windows out-of-the-box with no annoying "runtimes" required!

AutoIt was initially designed for PC "roll out" situations to reliably automate and configure thousands of PCs. Over time it has become a powerful language that supports complex expressions, user functions, loops and everything else that veteran scripters would expect.

Features:

*Easy to learn BASIC-like syntax
*Simulate keystrokes and mouse movements
*Manipulate windows and processes
*Interact with all standard windows controls
*Scripts can be compiled into standalone executables
*Create Graphical User Interfaces (GUIs)
*COM support
*Regular expressions
*Directly call external DLL and Windows API functions
*Scriptable RunAs functions
*Detailed helpfile and large community-based support forums
*Compatible with Windows XP / Server 2003 / Vista / Server 2008 / 7 / 8
*Unicode and x64 support
*Digitally signed for peace of mind
*Works with Windows User Account Control (UAC)

AutoIt has been designed to be as small as possible and stand-alone with no external .dll files or registry entries required making it safe to use on Servers. Scripts can be compiled into stand-alone executables with '''Aut2Exe'''.

Also supplied is a combined COM and DLL version of AutoIt called AutoItX that allows you to add the unique features of AutoIt to your own favorite scripting or programming languages!

Best of all, AutoIt continues to be free - but if you want to support the time, money and effort spent on the project and web hosting then you may donate at the AutoIt [http://www.autoitscript.com/autoit3/ homepage].

== Features in Detail ==

=== Basic-like Syntax and Rich Function Set ===

AutoIt has a BASIC-like syntax which means that most people who have ever written a script or used a high-level language should be able to pick it up easily.

Although it started life as a simple automation tool, AutoIt now has functions and features that allow it to be used as a general purpose scripting language (with awesome automation as well of course!). Language features include:

The usual high-level elements for functions, loops and expression parsing
A staggering amount of string handling functions '''and''' a Perl compatible regular expression engine (using the PCRE library).
COM support
Call Win32 and third-party DLL APIs

=== Built-in Editor with Syntax Highlighting ===

AutoIt comes with a customized "lite" version of SciTE that makes editing scripts easy. Users can also download a complete version of SciTE that includes additional tools to make things even easier.

=== Standalone and Small ===

AutoIt is a very small and standalone application with no reliance on massive runtimes such as .NET or VB. All you need to run AutoIt scripts are the main AutoIt executable (AutoIt3.exe) and the script. Scripts can also be encoded into standalone executables with the built-in script compiler '''Aut2Exe'''.

=== International and 64-bit Support ===

AutoIt is fully Unicode aware and also includes x64 versions of all the main components! How many other free scripting languages can you say that about?

=== Key and Mouse Simulation ===

Much time has been spent optimizing the keystroke and mouse simulation functions to be as accurate as possible on all versions of Windows. All the mouse and keyboard routines are highly configurable both in terms of simulation "speed" and functionality.

=== Window Management ===

You can expect to move, hide, show, resize, activate, close and pretty much do what you want with windows. Windows can be referenced by title, text on the window, size, position, class and even internal Win32 API handles.

=== Controls ===

Directly get information on and interact with edit boxes, check boxes, list boxes, combos, buttons, status bars without the risk of keystrokes getting lost. Even work with controls in windows that aren't active!

=== Graphical User Interfaces (GUIs) ===

AutoIt v3 will also allow you to create some complex GUIs - just like those below!

<center>[[Image:gui_eg1.png|284px|GUI Example 1]] [[Image:gui_eg2.png|274px|GUI Example 2]]</center>

And much, much more...

StringRegExp

2013-08-21T03:14:59Z

Jaberwocky6669:

<font face='Segoe UI, Courier New, Lucida Grande, Verdana, Helvetica, sans-serif'>

<font size='3' weight='normal'>Check if a string fits a given regular expression pattern.</font>

<font face='Courier New'><div id='Syntax' style='background-color:#FFFFAA;'>

:StringRegExp ( "test", "pattern" [, flag = 0 [, offset = 1]] )

</div></font>

<font size=4><div id='Section' style='color:#DB7100;'>Parameters</div></font>
{| class='wikitable'
|-
| test || The string to check
|-
| pattern || The regular expression to compare.
|-
| flag || '''[optional]''' A number to indicate how the function behaves. See below for details. The default is 0.
|-
| offset || '''[optional]''' The string position to start the match (starts at 1) The default is 1.
|}

{| class='wikitable'
|-
| '''Flag''' || '''Values'''
|-
| 0 || Returns 1 (matched) or 0 (no match)
|-
| 1 || Return array of matches.
|-
| 2 || Return array of matches including the full match (Perl / PHP style).
|-
| 3 || Return array of global matches.
|-
| 4 || Return an array of arrays containing global matches including the full match (Perl / PHP style).
|}

<font size=4><div id='Section' style='color:#DB7100;'>Return Value</div></font>
''Flag = 0 :''

{| class='wikitable'
! | @error:
! | Meaning
|-
| 2 || Bad pattern. @extended = offset of error in pattern.
|}

''Flag = 1 or 2 :''

{| class='wikitable'
! | @error:
! | Meaning
|-
| 0 || Array is valid. Check @extended for next offset
|-
| 1 || Array is invalid. No matches.
|-
| 2 || Bad pattern, array is invalid. @extended = offset of error in pattern.
|}

''Flag = 3 or 4 :''

{| class='wikitable'
! | @error:
! | Meaning
|-
| 0 || Array is valid.
|-
| 1 || Array is invalid. No matches.
|-
| 2 || Bad pattern, array is invalid. @extended = offset of error in pattern.
|}

<font size=4><div id='Section' style='color:#DB7100;'>Remarks</div></font>
The flag parameter can have one of 5 values (0 through 4). 0 gives a true (1) or false (0) as to whether the pattern was found or not. 1 and 2 find the first match and returns it in an array. 3 and 4 find multiple hits and fills the array with all the matching text. 2 and 4 include the full matching text as the first record, not just the capturing groups, which is all you get with flag 1 and 3.

Regular expression notation is a compact way of specifying a pattern for strings that can be searched. Regular expressions are character strings in which plain text characters indicate what text should exist in the target string, and a some characters are given special meanings to indicate what variability is allowed in the target string. AutoIt regular expressions are normally case-sensitive.

Regular expressions are constructed of one or more of the following simple regular expression specifiers. If the character is not in the following table, then it will match only itself.

Repeating characters (*, +, ?, {...} ) will try to match the largest set possible, which allows the following characters to match as well, unless followed immediately by a question mark; then it will find the smallest pattern that allows the following characters to match as well.

Nested groups are allowed, but keep in mind that all the groups, except non-capturing groups, assign to the returned array, with the outer groups assigning after the inner groups.

Complete description can be found ''''''

'''Caution''': bad regular expressions can produce a quasi-infinite loop hogging the CPU, and can even cause a crash.

'''<u>Matching Characters</u>'''

{| class='wikitable'
|-
| [ <nowiki>...</nowiki> ] || Match any character in the set. e.g. '''[aeiou]''' matches any lower-case vowel. A contiguous set can be defined using a dash between the starting and ending characters. e.g. '''[a-z]''' matches any lower case character. To include a dash ('''-''') in a set, use it as the first or last character of the set. To include a closing bracket in a set, use it as the first character of the set. e.g. '''[][]''' will match either [ or ]. Note that special characters '''do not''' retain their special meanings inside a set, with the exception of '''\\''', '''\^''', '''\-''','''\[''' and '''\]''' match the escaped character inside a set.
|-
| [^ <nowiki>...</nowiki> ] || Match any character '''not''' in the set. e.g. '''[^0-9]''' matches any non-digit. To include a caret ('''^''') in a set, put it after the beginning of the set or escape it (\^).
|-
| [:class:] || Match a character in the given class of characters. Valid classes are: alpha (any alphabetic character), alnum (any alphanumeric character), lower (any lower-case letter), upper (any upper-case letter), digit (any decimal digit 0-9), xdigit (any hexadecimal digit, 0-9, A-F, a-f), space (any whitespace character), blank (only a space or tab), print (any printable character), graph (any printable character except spaces), cntrl (any control character [ascii 127 or <32]) or punct (any punctuation character). So [0-9] is equivalent to <nowiki>[[</nowiki>:digit:<nowiki>]]</nowiki>.
|-
| [^:class:] || Match any character '''not''' in the class, but only if the first character.
|-
| ( <nowiki>...</nowiki> ) || Group. The elements in the group are treated in order and can be repeated together. e.g. '''(ab)+''' will match "ab" or "abab", but not "aba". A group will also store the text matched for use in back-references and in the array returned by the function, depending on flag value.
|-
| (?#<nowiki>...</nowiki>.) || comment (not nestable).
|-
| (?i) || Case-insensitivity flag. This does not operate as a group. It tells the regular expression engine to do case-insensitive matching from that point on.
|-
| (?-i) || (default) Case-sensitivity flag. This does not operate as a group. It tells the regular expression engine to do case-sensitive matching from that point on.
|-
| (?: <nowiki>...</nowiki> ) || Non-capturing group. Behaves just like a normal group, but does not record the matching characters in the array nor can the matched text be used for back-referencing.
|-
| (?i: <nowiki>...</nowiki> ) || Case-insensitive non-capturing group. Behaves just like a non-capturing group, but performs case-insensitive matches within the group.
|-
| (?-i: <nowiki>...</nowiki> ) || Case-sensitive non-capturing group. Behaves just like a non-capturing group, but performs case-sensitive matches within the group.
|-
| (?J) || allow duplicate names.
|-
| (?m) || ^ and $ match newlines within data.
|-
| (?s) || . matches anything including newline. (by default "." don't match newline)
|-
| (?U) || Invert greediness of quantifiers.
|-
| (?x) || Ignore whitespace and # comments.
|-
| (?-<nowiki>...</nowiki>) || unset option(s).
|-
| '''<nowiki>.</nowiki>''' || Match any single character (except newline).
|-
| <nowiki>|</nowiki> || Or. The expression on one side '''or''' the other can be matched.
|-
| \ || ''Escape'' a special character (have it match the actual character) or introduce a special character type (see below).
|-
| \\ || Match an actual backslash (\).
|-
| \a || Alarm, that is, the BEL character ((7)).
|-
| \A || Match only at beginning of string.
|-
| \b || Matches at a word boundary.
|-
| \B || Matches when not at a word boundary.
|-
| \c || Match a control character, based on the next character. For example, '''\cM''' matches ctrl-M.
|-
| \d || Match any digit (0-9).
|-
| \D || Match any non-digit.
|-
| \e || Match an escape character ((27)).
|-
| \E || end case modification.
|-
| \f || Match an formfeed character ((12)).
|-
| \G || first matching position in subject.
|-
| \h || any horizontal whitespace character.
|-
| \H || any character that is not a horizontal whitespace character.
|-
| \n || Match a linefeed (@LF, (10)).
|-
| \K || reset start of match.
|-
| \N || a character that is not a newline
|-
| \Q || quote (disable) pattern metacharacters till \E.
|-
| \r || Match a carriage return (@CR, (13)).
|-
| \R || a newline sequence.
|-
| \s || Match any whitespace character: (9) through (13) which are Horizontal Tab, Line Feed, Vertical Tab, Form Feed, and Carriage Return, and the standard space ( (32) ).
|-
| \S || Match any non-whitespace character.
|-
| \t || Match a tab character ((9)).
|-
| \v || any vertical whitespace character.
|-
| \V || any character that is not a vertical whitespace character.
|-
| \w || Match any "word" character: a-z, A-Z, 0-9 or underscore (_).
|-
| \W || Match any non-word character.
|-
| \X || A Unicode extended grapheme cluster, that is an unbreakable sequence of codepoints which represent a single character for the user.
|-
| \ddd || Match character with octal code ddd, or backreference if found. Match the prior group number given exactly. For example, '''([:alpha:])\1''' would match a double letter.
|-
| \xhh || character with hex code hh.
|-
| \x{hhh<nowiki>.</nowiki><nowiki>.</nowiki>} || Match character with hex code hhh..
|-
| \z || Match only at end of string.
|-
| \Z || Match only at end of string, or before newline at the end.
|-
| (?= <nowiki>...</nowiki> ) || Positive look ahead.
|-
| (?<= <nowiki>...</nowiki> ) || Positive look behind.
|-
| (?! <nowiki>...</nowiki> ) || Negative look ahead.
|-
| (?<! <nowiki>...</nowiki> ) || Negative look behind.
|}

<u>'''Repeating Characters</u>'''

{| class='wikitable'
|-
| {''x''} || Repeat the previous character, set or group exactly ''x'' times.
|-
| {''x'',} || Repeat the previous character, set or group at least ''x'' times.
|-
| {0,''x''} || Repeat the previous character, set or group at most ''x'' times.
|-
| {''x'', ''y''} || Repeat the previous character, set or group between ''x'' and ''y'' times, inclusive.
|-
| * || Repeat the previous character, set or group 0 or more times. Equivalent to {0,}
|-
| + || Repeat the previous character, set or group 1 or more times. Equivalent to {1,}
|-
| ? || The previous character, set or group may or may not appear. Equivalent to {0, 1}
|-
| ? (after a repeating character) || Find the smallest match instead of the largest.
|}

<u>'''Character Classes</u>'''

{| class='wikitable'
|-
| [:alnum:] || letters and digits (same as [0-9A-Za-z])
|-
| [:alpha:] || letters (same as [A-Za-z])
|-
| [:ascii:] || character codes (same as (0) ... (127))
|-
| [:blank:] || space or tab only (same as (9) and (32))
|-
| [:cntrl:] || control characters (same as (0) ... (31) and (127))
|-
| [:digit:] || decimal digits (same as \d or [0-9])
|-
| [:graph:] || printing characters, excluding space (same as (33) ... (126))
|-
| [:lower:] || lower case letters (same as [a-z])
|-
| [:print:] || printing characters, including space (same as (32) ... (126))
|-
| [:punct:] || printing characters, excluding [:alnum:] and [:cntrl:], (33-47, 58-64, 91-96, 123-126)
|-
| [:space:] || white space (not quite the same as \s, it includes VT: (11)) (same as [\f\n\r\t\v ])
|-
| [:upper:] || upper case letters (same as [A-Z])
|-
| [:word:] || "word" characters (same as \w)
|-
| [:xdigit:] || hexadecimal digits (same as [0-9A-Fa-f])
|}

<u>'''General comments about UTF-8 mode'''</u> (use internaly by AutoIt to translate pattern) :

1. An unbraced hexadecimal escape sequence (such as \xb3) matches a two-byte UTF-8 character if the value is greater than 127.

2. Octal numbers up to \777 are recognized, and match two-byte UTF-8 characters for values greater than \177.

3. Repeat quantifiers apply to complete UTF-8 characters, not to individual bytes, for example: \x{100}{3}.

4. The dot metacharacter matches one UTF-8 character instead of a single byte.

5. The character escapes \b, \B, \d, \D, \s, \S, \w, and \W correctly test characters of any code value, but the characters that PCRE recognizes as digits, spaces, or word characters remain the same set as before, all with values less than 256. Note that this also applies to \b, because it is defined in terms of \w and \W.

6. Similarly, characters that match the POSIX named character classes are all low-valued characters.

7. However, the Perl 5.10 horizontal and vertical whitespace matching escapes (\h, \H, \v, and \V) do match all the appropriate Unicode characters.

8. Case-insensitive matching applies only to characters whose values are less than 128. PCRE supports case-insensitive matching only when there is a one-to-one mapping between a letter's cases. There are a small number of many-to-one mappings in Unicode; these are not supported by PCRE.

See also the tutorial, in which you can run a script to test your regular expression(s).

<font size=4><div id='Section' style='color:#DB7100;'>Related</div></font>
[[StringInStr]], [[StringRegExpReplace]]

<font size=4><div id='Section' style='color:#DB7100;'>Example</div></font>
<syntaxhighlight lang='autoit'>
#include <MsgBoxConstants.au3>

; Option 1, using offset
Local $nOffset = 1

Local $aArray
While 1
$aArray = StringRegExp('<test>a</test> <test>b</test> <test>c</Test>', '<(?i)test>(.*?)</(?i)test>', 1, $nOffset)

If @error = 0 Then
$nOffset = @extended
Else
ExitLoop
EndIf
For $i = 0 To UBound($aArray) - 1
MsgBox($MB_SYSTEMMODAL, "RegExp Test with Option 1 - " & $i, $aArray[$i])
Next
WEnd

; Option 2, single return, php/preg_match() style
$aArray = StringRegExp('<test>a</test> <test>b</test> <test>c</Test>', '<(?i)test>(.*?)</(?i)test>', 2)
For $i = 0 To UBound($aArray) - 1
MsgBox($MB_SYSTEMMODAL, "RegExp Test with Option 2 - " & $i, $aArray[$i])
Next

; Option 3, global return, old AutoIt style
$aArray = StringRegExp('<test>a</test> <test>b</test> <test>c</Test>', '<(?i)test>(.*?)</(?i)test>', 3)

For $i = 0 To UBound($aArray) - 1
MsgBox($MB_SYSTEMMODAL, "RegExp Test with Option 3 - " & $i, $aArray[$i])
Next

; Option 4, global return, php/preg_match_all() style
$aArray = StringRegExp('F1oF2oF3o', '(F.o)*?', 4)

For $i = 0 To UBound($aArray) - 1

Local $match = $aArray[$i]
For $j = 0 To UBound($match) - 1
MsgBox($MB_SYSTEMMODAL, "RegExp Test with Option 4 - " & $i & ',' & $j, $match[$j])
Next
Next
</syntaxhighlight>
</font>
__NOTOC__

User:Jaberwocky6669

2013-08-20T05:51:37Z

Jaberwocky6669:

__NOTOC__

= 2013 Version =

<center>[[Image:logo2.png]]<br>
©1999-2013 Jonathan Bennett & [[AutoIt_Team | AutoIt Team]]<br>
[http://www.autoitscript.com/autoit3/index.php AutoIt v3 Homepage]<br>
<br></center>

== Introduction ==

AutoIt v3 is a freeware BASIC-like scripting language designed for automating the Windows GUI and general scripting. It uses a combination of simulated keystrokes, mouse movement and window/control manipulation in order to automate tasks in a way not possible or reliable with other languages (e.g. VBScript and SendKeys). AutoIt is also very small, self-contained and will run on all versions of Windows out-of-the-box with no annoying "runtimes" required!

AutoIt was initially designed for PC "roll out" situations to reliably automate and configure thousands of PCs. Over time it has become a powerful language that supports complex expressions, user functions, loops and everything else that veteran scripters would expect.

Features:

*Easy to learn BASIC-like syntax
*Simulate keystrokes and mouse movements
*Manipulate windows and processes
*Interact with all standard windows controls
*Scripts can be compiled into standalone executables
*Create Graphical User Interfaces (GUIs)
*COM support
*Regular expressions
*Directly call external DLL and Windows API functions
*Scriptable RunAs functions
*Detailed helpfile and large community-based support forums
*Compatible with Windows XP / Server 2003 / Vista / Server 2008 / 7 / 8
*Unicode and x64 support
*Digitally signed for peace of mind
*Works with Windows User Account Control (UAC)

AutoIt has been designed to be as small as possible and stand-alone with no external .dll files or registry entries required making it safe to use on Servers. Scripts can be compiled into stand-alone executables with '''Aut2Exe'''.

Also supplied is a combined COM and DLL version of AutoIt called AutoItX that allows you to add the unique features of AutoIt to your own favorite scripting or programming languages!

Best of all, AutoIt continues to be free - but if you want to support the time, money and effort spent on the project and web hosting then you may donate at the AutoIt [http://www.autoitscript.com/autoit3/ homepage].

== Features in Detail ==

=== Basic-like Syntax and Rich Function Set ===

AutoIt has a BASIC-like syntax which means that most people who have ever written a script or used a high-level language should be able to pick it up easily.

Although it started life as a simple automation tool, AutoIt now has functions and features that allow it to be used as a general purpose scripting language (with awesome automation as well of course!). Language features include:

The usual high-level elements for functions, loops and expression parsing
A staggering amount of string handling functions '''and''' a Perl compatible regular expression engine (using the PCRE library).
COM support
Call Win32 and third-party DLL APIs

=== Built-in Editor with Syntax Highlighting ===

AutoIt comes with a customized "lite" version of SciTE that makes editing scripts easy. Users can also download a complete version of SciTE that includes additional tools to make things even easier.

=== Standalone and Small ===

AutoIt is a very small and standalone application with no reliance on massive runtimes such as .NET or VB. All you need to run AutoIt scripts are the main AutoIt executable (AutoIt3.exe) and the script. Scripts can also be encoded into standalone executables with the built-in script compiler '''Aut2Exe'''.

=== International and 64-bit Support ===

AutoIt is fully Unicode aware and also includes x64 versions of all the main components! How many other free scripting languages can you say that about?

=== Key and Mouse Simulation ===

Much time has been spent optimizing the keystroke and mouse simulation functions to be as accurate as possible on all versions of Windows. All the mouse and keyboard routines are highly configurable both in terms of simulation "speed" and functionality.

=== Window Management ===

You can expect to move, hide, show, resize, activate, close and pretty much do what you want with windows. Windows can be referenced by title, text on the window, size, position, class and even internal Win32 API handles.

=== Controls ===

Directly get information on and interact with edit boxes, check boxes, list boxes, combos, buttons, status bars without the risk of keystrokes getting lost. Even work with controls in windows that aren't active!

=== Graphical User Interfaces (GUIs) ===

AutoIt v3 will also allow you to create some complex GUIs - just like those below!

<center>[[Image:gui_eg1.png|284px|GUI Example 1]] [[Image:gui_eg2.png|274px|GUI Example 2]]</center>

And much, much more...

StringRegExp

2013-08-20T05:00:39Z

Jaberwocky6669:

<font face='Segoe UI, Lucida Grande, Verdana, Helvetica, sans-serif'>

<font size='3' weight='normal'>Check if a string fits a given regular expression pattern.</font>

<div id='Syntax' style='background-color:#FFFFAA;'>:StringRegExp ( "test", "pattern" [, flag = 0 [, offset = 1]] )</div>

<font size='4'><div id='Section' style='color:#DB7100;'>Parameters</div></font>
{| class='wikitable'
|-
| test || The string to check
|-
| pattern || The regular expression to compare.
|-
| flag || '''[optional]''' A number to indicate how the function behaves. See below for details. The default is 0.
|-
| offset || '''[optional]''' The string position to start the match (starts at 1) The default is 1.
|}

{| class='wikitable'
|-
| '''Flag''' || '''Values'''
|-
| 0 || Returns 1 (matched) or 0 (no match)
|-
| 1 || Return array of matches.
|-
| 2 || Return array of matches including the full match (Perl / PHP style).
|-
| 3 || Return array of global matches.
|-
| 4 || Return an array of arrays containing global matches including the full match (Perl / PHP style).
|}

<font size='4'><div id='Section' style='color:#DB7100;'>Return Value</div></font>
''Flag = 0 :''

{| class='wikitable'
! | @error:
! | Meaning
|-
| 2 || Bad pattern. @extended = offset of error in pattern.
|}

''Flag = 1 or 2 :''

{| class='wikitable'
! | @error:
! | Meaning
|-
| 0 || Array is valid. Check @extended for next offset
|-
| 1 || Array is invalid. No matches.
|-
| 2 || Bad pattern, array is invalid. @extended = offset of error in pattern.
|}

''Flag = 3 or 4 :''

{| class='wikitable'
! | @error:
! | Meaning
|-
| 0 || Array is valid.
|-
| 1 || Array is invalid. No matches.
|-
| 2 || Bad pattern, array is invalid. @extended = offset of error in pattern.
|}

<font size='4'><div id='Section' style='color:#DB7100;'>Remarks</div></font>
The flag parameter can have one of 5 values (0 through 4). 0 gives a true (1) or false (0) as to whether the pattern was found or not. 1 and 2 find the first match and returns it in an array. 3 and 4 find multiple hits and fills the array with all the matching text. 2 and 4 include the full matching text as the first record, not just the capturing groups, which is all you get with flag 1 and 3.

Regular expression notation is a compact way of specifying a pattern for strings that can be searched. Regular expressions are character strings in which plain text characters indicate what text should exist in the target string, and a some characters are given special meanings to indicate what variability is allowed in the target string. AutoIt regular expressions are normally case-sensitive.

Regular expressions are constructed of one or more of the following simple regular expression specifiers. If the character is not in the following table, then it will match only itself.

Repeating characters (*, +, ?, {...} ) will try to match the largest set possible, which allows the following characters to match as well, unless followed immediately by a question mark; then it will find the smallest pattern that allows the following characters to match as well.

Nested groups are allowed, but keep in mind that all the groups, except non-capturing groups, assign to the returned array, with the outer groups assigning after the inner groups.

Complete description can be found '''[[here]]'''

'''Caution''': bad regular expressions can produce a quasi-infinite loop hogging the CPU, and can even cause a crash.

'''<u>Matching Characters</u>'''

{| class='wikitable'
|-
| [ <nowiki>...</nowiki> ] || Match any character in the set. e.g. '''[aeiou]''' matches any lower-case vowel. A contiguous set can be defined using a dash between the starting and ending characters. e.g. '''[a-z]''' matches any lower case character. To include a dash ('''-''') in a set, use it as the first or last character of the set. To include a closing bracket in a set, use it as the first character of the set. e.g. '''[][]''' will match either [ or ]. Note that special characters '''do not''' retain their special meanings inside a set, with the exception of '''\\''', '''\^''', '''\-''','''\[''' and '''\]''' match the escaped character inside a set.
|-
| [^ <nowiki>...</nowiki> ] || Match any character '''not''' in the set. e.g. '''[^0-9]''' matches any non-digit. To include a caret ('''^''') in a set, put it after the beginning of the set or escape it (\^).
|-
| [:class:] || Match a character in the given class of characters. Valid classes are: alpha (any alphabetic character), alnum (any alphanumeric character), lower (any lower-case letter), upper (any upper-case letter), digit (any decimal digit 0-9), xdigit (any hexadecimal digit, 0-9, A-F, a-f), space (any whitespace character), blank (only a space or tab), print (any printable character), graph (any printable character except spaces), cntrl (any control character [ascii 127 or <32]) or punct (any punctuation character). So [0-9] is equivalent to <nowiki>[[</nowiki>:digit:<nowiki>]]</nowiki>.
|-
| [^:class:] || Match any character '''not''' in the class, but only if the first character.
|-
| ( <nowiki>...</nowiki> ) || Group. The elements in the group are treated in order and can be repeated together. e.g. '''(ab)+''' will match "ab" or "abab", but not "aba". A group will also store the text matched for use in back-references and in the array returned by the function, depending on flag value.
|-
| (?#<nowiki>...</nowiki>.) || comment (not nestable).
|-
| (?i) || Case-insensitivity flag. This does not operate as a group. It tells the regular expression engine to do case-insensitive matching from that point on.
|-
| (?-i) || (default) Case-sensitivity flag. This does not operate as a group. It tells the regular expression engine to do case-sensitive matching from that point on.
|-
| (?: <nowiki>...</nowiki> ) || Non-capturing group. Behaves just like a normal group, but does not record the matching characters in the array nor can the matched text be used for back-referencing.
|-
| (?i: <nowiki>...</nowiki> ) || Case-insensitive non-capturing group. Behaves just like a non-capturing group, but performs case-insensitive matches within the group.
|-
| (?-i: <nowiki>...</nowiki> ) || Case-sensitive non-capturing group. Behaves just like a non-capturing group, but performs case-sensitive matches within the group.
|-
| (?J) || allow duplicate names.
|-
| (?m) || ^ and $ match newlines within data.
|-
| (?s) || . matches anything including newline. (by default "." don't match newline)
|-
| (?U) || Invert greediness of quantifiers.
|-
| (?x) || Ignore whitespace and # comments.
|-
| (?-<nowiki>...</nowiki>) || unset option(s).
|-
| '''<nowiki>.</nowiki>''' || Match any single character (except newline).
|-
| <nowiki>|</nowiki> || Or. The expression on one side '''or''' the other can be matched.
|-
| \ || ''Escape'' a special character (have it match the actual character) or introduce a special character type (see below).
|-
| \\ || Match an actual backslash (\).
|-
| \a || Alarm, that is, the BEL character ([[Chr]](7)).
|-
| \A || Match only at beginning of string.
|-
| \b || Matches at a word boundary.
|-
| \B || Matches when not at a word boundary.
|-
| \c || Match a control character, based on the next character. For example, '''\cM''' matches ctrl-M.
|-
| \d || Match any digit (0-9).
|-
| \D || Match any non-digit.
|-
| \e || Match an escape character ([[Chr]](27)).
|-
| \E || end case modification.
|-
| \f || Match an formfeed character ([[Chr]](12)).
|-
| \G || first matching position in subject.
|-
| \h || any horizontal whitespace character.
|-
| \H || any character that is not a horizontal whitespace character.
|-
| \n || Match a linefeed (@LF, [[Chr]](10)).
|-
| \K || reset start of match.
|-
| \N || a character that is not a newline
|-
| \Q || quote (disable) pattern metacharacters till \E.
|-
| \r || Match a carriage return (@CR, [[Chr]](13)).
|-
| \R || a newline sequence.
|-
| \s || Match any whitespace character: [[Chr]](9) through [[Chr]](13) which are Horizontal Tab, Line Feed, Vertical Tab, Form Feed, and Carriage Return, and the standard space ( [[Chr]](32) ).
|-
| \S || Match any non-whitespace character.
|-
| \t || Match a tab character ([[Chr]](9)).
|-
| \v || any vertical whitespace character.
|-
| \V || any character that is not a vertical whitespace character.
|-
| \w || Match any "word" character: a-z, A-Z, 0-9 or underscore (_).
|-
| \W || Match any non-word character.
|-
| \X || A Unicode extended grapheme cluster, that is an unbreakable sequence of codepoints which represent a single character for the user.
|-
| \ddd || Match character with octal code ddd, or backreference if found. Match the prior group number given exactly. For example, '''([:alpha:])\1''' would match a double letter.
|-
| \xhh || character with hex code hh.
|-
| \x{hhh<nowiki>.</nowiki><nowiki>.</nowiki>} || Match character with hex code hhh..
|-
| \z || Match only at end of string.
|-
| \Z || Match only at end of string, or before newline at the end.
|-
| (?= <nowiki>...</nowiki> ) || Positive look ahead.
|-
| (?<= <nowiki>...</nowiki> ) || Positive look behind.
|-
| (?! <nowiki>...</nowiki> ) || Negative look ahead.
|-
| (?<! <nowiki>...</nowiki> ) || Negative look behind.
|}

<u>'''Repeating Characters</u>'''

{| class='wikitable'
|-
| {''x''} || Repeat the previous character, set or group exactly ''x'' times.
|-
| {''x'',} || Repeat the previous character, set or group at least ''x'' times.
|-
| {0,''x''} || Repeat the previous character, set or group at most ''x'' times.
|-
| {''x'', ''y''} || Repeat the previous character, set or group between ''x'' and ''y'' times, inclusive.
|-
| * || Repeat the previous character, set or group 0 or more times. Equivalent to {0,}
|-
| + || Repeat the previous character, set or group 1 or more times. Equivalent to {1,}
|-
| ? || The previous character, set or group may or may not appear. Equivalent to {0, 1}
|-
| ? (after a repeating character) || Find the smallest match instead of the largest.
|}

<u>'''Character Classes</u>'''

{| class='wikitable'
|-
| [:alnum:] || letters and digits (same as [0-9A-Za-z])
|-
| [:alpha:] || letters (same as [A-Za-z])
|-
| [:ascii:] || character codes (same as [[Chr]](0) ... [[Chr]](127))
|-
| [:blank:] || space or tab only (same as [[Chr]](9) and [[Chr]](32))
|-
| [:cntrl:] || control characters (same as [[Chr]](0) ... [[Chr]](31) and [[Chr]](127))
|-
| [:digit:] || decimal digits (same as \d or [0-9])
|-
| [:graph:] || printing characters, excluding space (same as [[Chr]](33) ... [[Chr]](126))
|-
| [:lower:] || lower case letters (same as [a-z])
|-
| [:print:] || printing characters, including space (same as [[Chr]](32) ... [[Chr]](126))
|-
| [:punct:] || printing characters, excluding [:alnum:] and [:cntrl:], (33-47, 58-64, 91-96, 123-126)
|-
| [:space:] || white space (not quite the same as \s, it includes VT: [[Chr]](11)) (same as [\f\n\r\t\v ])
|-
| [:upper:] || upper case letters (same as [A-Z])
|-
| [:word:] || "word" characters (same as \w)
|-
| [:xdigit:] || hexadecimal digits (same as [0-9A-Fa-f])
|}

<u>'''General comments about UTF-8 mode'''</u> (use internaly by AutoIt to translate pattern) :

1. An unbraced hexadecimal escape sequence (such as \xb3) matches a two-byte UTF-8 character if the value is greater than 127.

2. Octal numbers up to \777 are recognized, and match two-byte UTF-8 characters for values greater than \177.

3. Repeat quantifiers apply to complete UTF-8 characters, not to individual bytes, for example: \x{100}{3}.

4. The dot metacharacter matches one UTF-8 character instead of a single byte.

5. The character escapes \b, \B, \d, \D, \s, \S, \w, and \W correctly test characters of any code value, but the characters that PCRE recognizes as digits, spaces, or word characters remain the same set as before, all with values less than 256. Note that this also applies to \b, because it is defined in terms of \w and \W.

6. Similarly, characters that match the POSIX named character classes are all low-valued characters.

7. However, the Perl 5.10 horizontal and vertical whitespace matching escapes (\h, \H, \v, and \V) do match all the appropriate Unicode characters.

8. Case-insensitive matching applies only to characters whose values are less than 128. PCRE supports case-insensitive matching only when there is a one-to-one mapping between a letter's cases. There are a small number of many-to-one mappings in Unicode; these are not supported by PCRE.

See also the [[Regular Expression]] tutorial, in which you can run a script to test your regular expression(s).

<font size='4'><div id='Section' style='color:#DB7100;'>Related</div></font>
[[StringInStr]], [[StringRegExpReplace]]

<font size='4'><div id='Section' style='color:#DB7100;'>Example</div></font>
<syntaxhighlight lang='autoit'>
#include <MsgBoxConstants.au3>

; Option 1, using offset
Local $nOffset = 1

Local $aArray
While 1
$aArray = StringRegExp('<test>a</test> <test>b</test> <test>c</Test>', '<(?i)test>(.*?)</(?i)test>', 1, $nOffset)

If @error = 0 Then
$nOffset = @extended
Else
ExitLoop
EndIf
For $i = 0 To UBound($aArray) - 1
MsgBox($MB_SYSTEMMODAL, "RegExp Test with Option 1 - " & $i, $aArray[$i])
Next
WEnd

; Option 2, single return, php/preg_match() style
$aArray = StringRegExp('<test>a</test> <test>b</test> <test>c</Test>', '<(?i)test>(.*?)</(?i)test>', 2)
For $i = 0 To UBound($aArray) - 1
MsgBox($MB_SYSTEMMODAL, "RegExp Test with Option 2 - " & $i, $aArray[$i])
Next

; Option 3, global return, old AutoIt style
$aArray = StringRegExp('<test>a</test> <test>b</test> <test>c</Test>', '<(?i)test>(.*?)</(?i)test>', 3)

For $i = 0 To UBound($aArray) - 1
MsgBox($MB_SYSTEMMODAL, "RegExp Test with Option 3 - " & $i, $aArray[$i])
Next

; Option 4, global return, php/preg_match_all() style
$aArray = StringRegExp('F1oF2oF3o', '(F.o)*?', 4)

For $i = 0 To UBound($aArray) - 1

Local $match = $aArray[$i]
For $j = 0 To UBound($match) - 1
MsgBox($MB_SYSTEMMODAL, "RegExp Test with Option 4 - " & $i & ',' & $j, $match[$j])
Next
Next
</syntaxhighlight>
</font>
__NOTOC__

ControlCommand

2013-08-20T03:18:07Z

Jaberwocky6669:

2013-08-18T07:30:35Z

Jaberwocky6669:

==Description==
Sends a command to a control.

<pre>
ControlCommand ( "title", "text", controlID, "command" [, "option"] )
</pre>

==Parameters==
{| border='1' class='wikitable'
| title || The title/hWnd/class of the window to access.
|-
| text || The text of the window to access.
|-
| controlID || The control to interact with. See [[Controls]]
|-
| command || The command to send to the control.
|-
| option || [optional] Additional parameter required by some commands.
|}

==Return Value==
Depends on command as table below shows. In case of an error (such as an invalid command or window/control), @error=1.

{| border='1' class='wikitable'
! scope='col' | '''Command''', '''Option'''
! scope='col' | '''Return Value'''
|-
| "IsVisible", "" || Returns 1 if Control is visible, 0 otherwise
|-
| "IsEnabled", "" || Returns 1 if Control is enabled, 0 otherwise
|-
| "ShowDropDown", "" || Displays the ComboBox dropdown
|-
| "HideDropDown", "" || Hides the ComboBox dropdown
|-
| "AddString", 'string' || Adds a string to the end in a ListBox or ComboBox
|-
| "DelString", occurrence || Deletes a string according to occurrence in a ListBox or ComboBox
|-
| "FindString", 'string' || Returns occurrence ref of the exact string in a ListBox or ComboBox
|-
| "SetCurrentSelection", ''occurrence'' || Sets selection to occurrence ref in a ListBox or ComboBox
|-
| "SelectString", 'string' || Sets selection according to string in a ListBox or ComboBox
|-
| "IsChecked", "" || Returns 1 if Button is checked, 0 otherwise
|-
| "Check", "" || Checks radio or check Button
|-
| "UnCheck", "" || Unchecks radio or check Button
|-
| "GetCurrentLine", "" || Returns the line # where the caret is in an Edit
|-
| "GetCurrentCol", "" || Returns the column # where the caret is in an Edit
|-
| "GetCurrentSelection", "" || Returns name of the currently selected item in a ListBox or ComboBox
|-
| "GetLineCount", "" || Returns # of lines in an Edit
|-
| "GetLine", ''line''# || Returns text at line # passed of an Edit
|-
| "GetSelected", "" || Returns selected text of an Edit
|-
| "EditPaste", 'string' || Pastes the 'string' at the Edit's caret position
|-
| "CurrentTab", "" || Returns the current Tab shown of a SysTabControl32
|-
| "TabRight", "" || Moves to the next tab to the right of a SysTabControl32
|-
| "TabLeft", "" || Moves to the next tab to the left of a SysTabControl32
|-
| "SendCommandID", ''Command ID'' || Simulates the WM_COMMAND message. Usually used for ToolbarWindow32 controls - use the ToolBar tab of Au3Info to get the Command ID.
|}

==Remarks==
Some controls will resist automation unless they are the active window. Use the [[WinActivate]] function to force the control's window to the top before using [[WinActivate]] on these controls.

Certain commands that work on normal Combo and ListBoxes do not work on "ComboLBox" controls.

==Related==
[[ControlTreeView]]

==Example==
<syntaxhighlight lang='autoit'>
#include <MsgBoxConstants.au3>

Example()

Func Example()
; Run Notepad
Run("notepad.exe")

; Wait 10 seconds for the Notepad window to appear.
Local $hWnd = WinWait("[CLASS:Notepad]", "", 10)

; Send a command to the edit control of Notepad to find the number of lines. The handle returned by WinWait is used for the "title" parameter of ControlCommand.
Local $iCount = ControlCommand($hWnd, "", "Edit1", "GetLineCount", "")

; Display the number of lines.
MsgBox($MB_SYSTEMMODAL, "", "The number of lines in Notepad are: " & $iCount)

; Close the Notepad window using the handle returned by WinWait.
WinClose($hWnd)
EndFunc ;==>Example
</syntaxhighlight>

__NOTOC__

AutoItSetOption

2013-08-18T06:42:13Z

Jaberwocky6669: