AutoIt Wiki - User contributions [en]

Snippets ( AutoIt Array )

2013-10-22T19:01:20Z

DatMCEyeBall: /* _ArrayEmpty */

__TOC__

[[category:Snippets]]

{{Snippet Credit Header}}

== _1Dto2DArray ==

{{Snippet Header
|AuthorURL=35302-guinness
|AuthorName=guinness
}}

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

Global $aArray_1D[2] = ["Data", "Data"]
_ArrayDisplay($aArray_1D)
_1Dto2DArray($aArray_1D)
_ArrayDisplay($aArray_1D)

Global $aArray_1D[10] = ["Data", "Data", "Data", "Data", "Data", "Data", "Data", "Data", "Data", "Data"]
_ArrayDisplay($aArray_1D)
_1Dto2DArray($aArray_1D, 9)
_ArrayDisplay($aArray_1D)

Func _1Dto2DArray(ByRef $aArray, Const $iAdditionalColumns = 1)
Local Const $iSize = UBound($aArray, 1)

Local $aReturn[$iSize][$iAdditionalColumns + 1]

For $A = 0 To $iSize - 1
$aReturn[$A][0] = $aArray[$A]
Next

$aArray = $aReturn

Return $aReturn
EndFunc ;==>_1Dto2DArray
</syntaxhighlight>

[[#top | ReturnToContents]]

== _ArrayAddEx ==

{{Snippet Header
|AuthorURL=35302-guinness
|AuthorName=guinness
}}

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

Example_1()
Example_2()

Func Example_1()
Local $aArray_1[1] = ["Data_0"], $iBegin

$iBegin = TimerInit() ; Start the timer.
For $i = 1 To 5000
_ArrayAdd($aArray_1, "Data_" & $i)
Next
$iBegin = TimerDiff($iBegin) ; End the timer and find the difference from start to finish.
ConsoleWrite("_ArrayAdd from Array.au3 >> " & $iBegin & @CRLF)
_ArrayDisplay($aArray_1)
EndFunc ;==>Example_1

Func Example_2()
Local $aArray_2[1] = ["Data_0"], $iBegin, $iDimension, $iCount

$iBegin = TimerInit() ; Start the timer.
For $i = 1 To 5000
_ArrayAddEx($aArray_2, "Data_" & $i, $iDimension, $iCount) ; $iDimension is the overall size of the array & $iCount is the last index number, because regarding the overall size +1 as the next item will give false results as we're increasing the size of the array not by 1 but multiplying 2.
Next
$iBegin = TimerDiff($iBegin) ; End the timer and find the difference from start to finish.
ConsoleWrite("_ArrayAddEx by guinness >> " & $iBegin & @CRLF)
ReDim $aArray_2[$iCount] ; Remove the empty rows.
_ArrayDisplay($aArray_2)
EndFunc ;==>Example_2

Func _ArrayAddEx(ByRef $aArray, $sData, ByRef $iDimension, ByRef $iCount) ; Taken from Array.au3 and modified by guinness to reduce the use of ReDim.
If IsArray($aArray) = 0 Then
Return SetError(1, 0, -1)
EndIf

If UBound($aArray, 0) <> 1 Then
Return SetError(2, 0, -1)
EndIf

If $iCount = 0 Then
$iCount = UBound($aArray, 1)
EndIf

$iCount += 1
If ($iCount + 1) >= $iDimension Then
$iDimension = (UBound($aArray, 1) + 1) * 2
ReDim $aArray[$iDimension]
EndIf
$aArray[$iCount - 1] = $sData
Return $iCount - 1
EndFunc ;==>_ArrayAddEx
</syntaxhighlight>

[[#top | ReturnToContents]]

== _ArrayEmpty ==

{{Snippet Header
|AuthorURL=35302-guinness
|AuthorName=guinness
|Desc=Creates Empty 1D & 2D Array's
}}

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

Global $aMain[11] = [10]
_ArrayEmpty($aMain)
_ArrayDisplay($aMain, "Empty 1D Array.")

Global $aMainEx[11][3] = [[10]]
_ArrayEmpty($aMainEx)
_ArrayDisplay($aMainEx, "Empty 2D Array.")

Func _ArrayEmpty(ByRef $aArray)
Switch UBound($aArray, 0) ; Dimension, 1D or 2D array are supported.
Case 1
Local $aEmpty1D[1]
$aArray = $aEmpty1D

Case 2
; Edit by DatMCEyeBall - Instead of emptying the array to [1][$x] we empty it to [$x][$y]
; where $x is the 1st dimensions size and $y the 2nd.
; Previous code was: Local $aEmpty2D[1][UBound($aArray, 2)]
; This way we preserve the arrays' original size.
Local $aEmpty2D[UBound($aArray, 1)][UBound($aArray, 2)]
$aArray = $aEmpty2D
EndSwitch
EndFunc ;==>_ArrayEmpty
</syntaxhighlight>

[[#top | ReturnToContents]]

== _ArrayGet ==

{{Snippet Header
|AuthorURL=31965-progandy
|AuthorName=ProgAndy
|Desc=Easy access for nested arrays up to 20 nested dimensions (including multidimensional arrays)
}}

<syntaxhighlight lang = "autoit">
Global $b[2] = ["a", "b"]
Global $a[3][2] = [[0, -1], [$b, "x"], [1, -2]]

Global $c[5] = [11, 22, 33, 44, 55]

MsgBox(0, "", _ArrayGet($a, 1, 0, 1) & " # " & @error)

; #FUNCTION# ====================================================================================================================
; Name ..........: _ArrayGet
; Description ...: Gets a value from a nested multidimensional array
; Syntax ........: _ArrayGet(Byref $aArray, $i1[, $i2 = 0[, $i3 = 0[, $i4 = 0[, $i5 = 0[, $i6 = 0[, $i7 = 0[, $i8 = 0[,
; $i9 = 0[, $i10 = 0[, $i11 = 0[, $i12 = 0[, $i13 = 0[, $i14 = 0[, $i15 = 0[, $i16 = 0[, $i17 = 0[,
; $i18 = 0[, $i19 = 0[, $i20 = 0]]]]]]]]]]]]]]]]]]])
; Parameters ....: $aArray - [in/out] An array of unknowns.
; $i1 - first array index.
; $i2 - [optional] second array index.
; $i3 - [optional] third array index.
; $i4 - [optional] fourth array index.
; $i5 - [optional] fifth array index.
; $i6 - [optional] sixth array index.
; $i7 - [optional] seventh array index.
; $i8 - [optional] eighth array index.
; $i9 - [optional] ninth array index.
; $i10 - [optional] 10th array index.
; $i11 - [optional] 11th array index.
; $i12 - [optional] 12th array index.
; $i13 - [optional] 13th array index.
; $i14 - [optional] 14th array index.
; $i15 - [optional] 15th array index.
; $i16 - [optional] 16th array index.
; $i17 - [optional] 17th array index.
; $i18 - [optional] 18th array index.
; $i19 - [optional] 19th array index.
; $i20 - [optional] 20th array index.
; Return values .: Success: Value at the specified index
; Error: Nothing, Sets @error to:
; |1 - Trying to acces non-array as array
; |2 - Not enough dimensions for the last accessed array
; |3 - Index out of bounds for a dimension
; @extended contains the dimension in error (according to parameter list)
; Author ........: ProgAndy
; Modified ......:
; Remarks .......:
; Related .......:
; Link ..........:
; Example .......: No
; ===============================================================================================================================
Func _ArrayGet(ByRef $aArray, $i1, $i2=0, $i3=0, $i4=0, $i5=0, $i6=0, $i7=0, $i8=0, $i9=0, $i10=0, $i11=0, $i12=0, $i13=0, $i14=0, $i15=0, $i16=0, $i17=0, $i18=0, $i19=0, $i20=0)
#forceref $i1, $i2, $i3, $i4, $i5, $i6, $i7, $i8, $i9, $i10, $i11, $i12, $i13, $i14, $i15, $i16, $i17, $i18, $i19, $i20
; ProgAndy
Local $NULL
If Not IsArray($aArray) Then Return SetError(1, 1, $NULL)
Local $iDims = UBound($aArray, 0)
If @NumParams <= $iDims Then Return SetError(2, @NumParams, $NULL)
Local $sAccess = "$aArray"
For $i = 1 To $iDims
Local $iIndex = Int(Eval("i" & $i))
If $iIndex >= UBound($aArray, $i) Then Return SetError(3, $i, $NULL)
$sAccess &= '[' & $iIndex & ']'
Next
If @NumParams-1 > $iDims Then ; Still indices left
For $i = $iDims+1 To @NumParams-1
$sAccess &= ", $i" & $i
Next
Local $vResult = Execute("_ArrayGet(" & $sAccess & ")")
If @error Then SetError(@error, @extended+$iDims)
Return $vResult
Else ;
Return Execute($sAccess)
EndIf
EndFunc
</syntaxhighlight>

[[#top | ReturnToContents]]

== _ArraySet ==

{{Snippet Header
|AuthorURL=31965-progandy
|AuthorName=ProgAndy
|Desc=Easy access for nested arrays up to 20 nested dimensions (including multidimensional arrays)
}}

<syntaxhighlight lang = "autoit">
Global $b[2] = ['a', 'b'
Global $a[3][2] = [[0, -1], [$b, "x"], [1, -2]]

Global $c[5] = [11, 22, 33, 44, 55]

_ArraySet($a, $c, 1, 0, 0)

; #FUNCTION# ====================================================================================================================
; Name ..........: _ArraySet
; Description ...: Sets a value from a nested multidimensional array
; Syntax ........: _ArraySet(Byref $aArray, $vValue, $i1[, $i2 = 0[, $i3 = 0[, $i4 = 0[, $i5 = 0[, $i6 = 0[, $i7 = 0[, $i8 = 0[,
; $i9 = 0[, $i10 = 0[, $i11 = 0[, $i12 = 0[, $i13 = 0[, $i14 = 0[, $i15 = 0[, $i16 = 0[, $i17 = 0[,
; $i18 = 0[, $i19 = 0[, $i20 = 0]]]]]]]]]]]]]]]]]]])
; Parameters ....: $aArray - [in/out] An array of unknowns.
; $vValue - value to set at specified index.
; $i1 - first array index.
; $i2 - [optional] second array index.
; $i3 - [optional] third array index.
; $i4 - [optional] fourth array index.
; $i5 - [optional] fifth array index.
; $i6 - [optional] sixth array index.
; $i7 - [optional] seventh array index.
; $i8 - [optional] eighth array index.
; $i9 - [optional] ninth array index.
; $i10 - [optional] 10th array index.
; $i11 - [optional] 11th array index.
; $i12 - [optional] 12th array index.
; $i13 - [optional] 13th array index.
; $i14 - [optional] 14th array index.
; $i15 - [optional] 15th array index.
; $i16 - [optional] 16th array index.
; $i17 - [optional] 17th array index.
; $i18 - [optional] 18th array index.
; $i19 - [optional] 19th array index.
; $i20 - [optional] 20th array index.
; Return values .: Success: True
; Error: False, Sets @error to:
; |1 - Trying to acces non-array as array
; |2 - Not enough dimensions for the last accessed array
; |3 - Index out of bounds for a dimension
; |all: - @extended contains the dimension in error (according to parameter list)
; Author ........: ProgAndy
; Modified ......:
; Remarks .......:
; Related .......:
; Link ..........:
; Example .......: No
; ===============================================================================================================================
Func _ArraySet(ByRef $aArray, Const $vValue, $i1, $i2=0, $i3=0, $i4=0, $i5=0, $i6=0, $i7=0, $i8=0, $i9=0, $i10=0, $i11=0, $i12=0, $i13=0, $i14=0, $i15=0, $i16=0, $i17=0, $i18=0, $i19=0, $i20=0)
; ProgAndy
Local Const $NULL = False

If Not IsArray($aArray) Then Return SetError(1, 1, $NULL)

Local $iDims = UBound($aArray, 0)

If @NumParams-2 < $iDims Then Return SetError(2, @NumParams-1, $NULL)

Local $sAccess = "$aArray"

For $i = 1 To $iDims
Local $iIndex = Int(Eval("i" & $i))
If $iIndex >= UBound($aArray, $i) Then Return SetError(3, $i, $NULL)
$sAccess &= '[' & $iIndex & ']'
Next

If @NumParams-2 > $iDims Then
$sAccess &= ", $vValue"
For $i = $iDims+1 To @NumParams-2
$sAccess &= ", $i" & $i
Next
Local $fSuccess = Execute("_ArraySet(" & $sAccess & ")")
If @error Then SetError(@error, @extended+$iDims)
Return $fSuccess
EndIf

Switch $iDims
Case 1
$aArray[$i1] = $vValue
Case 2
$aArray[$i1][$i2] = $vValue
Case 3
$aArray[$i1][$i2][$i3] = $vValue
Case 4
$aArray[$i1][$i2][$i3][$i4] = $vValue
Case 5
$aArray[$i1][$i2][$i3][$i4][$i5] = $vValue
Case 6
$aArray[$i1][$i2][$i3][$i4][$i5][$i6] = $vValue
Case 7
$aArray[$i1][$i2][$i3][$i4][$i5][$i6][$i7] = $vValue
Case 8
$aArray[$i1][$i2][$i3][$i4][$i5][$i6][$i7][$i8] = $vValue
Case 9
$aArray[$i1][$i2][$i3][$i4][$i5][$i6][$i7][$i8][$i9] = $vValue
Case 10
$aArray[$i1][$i2][$i3][$i4][$i5][$i6][$i7][$i8][$i9][$i10] = $vValue
Case 11
$aArray[$i1][$i2][$i3][$i4][$i5][$i6][$i7][$i8][$i9][$i10][$i11] = $vValue
Case 12
$aArray[$i1][$i2][$i3][$i4][$i5][$i6][$i7][$i8][$i9][$i10][$i11][$i12] = $vValue
Case 13
$aArray[$i1][$i2][$i3][$i4][$i5][$i6][$i7][$i8][$i9][$i10][$i11][$i12][$i13] = $vValue
Case 14
$aArray[$i1][$i2][$i3][$i4][$i5][$i6][$i7][$i8][$i9][$i10][$i11][$i12][$i13][$i14] = $vValue
Case 15
$aArray[$i1][$i2][$i3][$i4][$i5][$i6][$i7][$i8][$i9][$i10][$i11][$i12][$i13][$i14][$i15] = $vValue
Case 16
$aArray[$i1][$i2][$i3][$i4][$i5][$i6][$i7][$i8][$i9][$i10][$i11][$i12][$i13][$i14][$i15][$i16] = $vValue
Case 17
$aArray[$i1][$i2][$i3][$i4][$i5][$i6][$i7][$i8][$i9][$i10][$i11][$i12][$i13][$i14][$i15][$i16][$i17] = $vValue
Case 18
$aArray[$i1][$i2][$i3][$i4][$i5][$i6][$i7][$i8][$i9][$i10][$i11][$i12][$i13][$i14][$i15][$i16][$i17][$i18] = $vValue
Case 19
$aArray[$i1][$i2][$i3][$i4][$i5][$i6][$i7][$i8][$i9][$i10][$i11][$i12][$i13][$i14][$i15][$i16][$i17][$i18][$i19] = $vValue
Case 20
$aArray[$i1][$i2][$i3][$i4][$i5][$i6][$i7][$i8][$i9][$i10][$i11][$i12][$i13][$i14][$i15][$i16][$i17][$i18][$i19][$i20] = $vValue
EndSwitch

Return True
EndFunc
</syntaxhighlight>

[[#top | ReturnToContents]]

== _ArrayLength ==

{{Snippet Header
|AuthorURL=35302-guinness
|AuthorName=guinness
}}

<syntaxhighlight lang = "autoit">
Global $aArray[2][50]
ConsoleWrite(_ArrayLength($aArray, 2) & @CRLF) ;= > 10 - Total items
ConsoleWrite(_ArrayLength($aArray, 1) & @CRLF) ;= > 5 - Columns
ConsoleWrite(_ArrayLength($aArray, 0) & @CRLF) ;= > 2 - Rows

ConsoleWrite(@CRLF)

Global $aArray[2]
ConsoleWrite(_ArrayLength($aArray, 2) & @CRLF) ;= > 2 - Total items
ConsoleWrite(_ArrayLength($aArray, 1) & @CRLF) ;= > 1 - Columns
ConsoleWrite(_ArrayLength($aArray, 0) & @CRLF) ;= > 2 - Rows

Func _ArrayLength($aArray, $iType = 1)
Local $iDim = UBound($aArray, 0)

If $iDim < 0 Or $iDim > 2 Then ; If not a 1D or 2D Array, then return -1 and set @error to non-zero.
Return SetError(1, 0, -1)
EndIf

Switch $iType
Case 2
If $iDim = 2 Then
Return UBound($aArray, 2) * UBound($aArray, 1)
Else
Return UBound($aArray, 1)
EndIf

Case 1
If $iDim = 2 Then
Return UBound($aArray, 2)
Else
Return 1
EndIf

Case Else
Return UBound($aArray, 1)
EndSwitch
EndFunc ;==>_ArrayLength
</syntaxhighlight>

[[#top | ReturnToContents]]

== _ArraySortNum ==

{{Snippet Header
|AuthorURL=4813-smoke-n
|AuthorName=SmOke_N
}}

<syntaxhighlight lang = "autoit">
; ArraySortNum(ByRef $nArray, $Ascending = 0, $Start = 1)
; Sorts arrays based on TRUE Numerical Order, including Decimals

#include <Array.au3>

; Example sort Array created with StringSplit.
Global $avArray = StringSplit("6,8,10,4,2,13,12,129,106.1,106.4", ",")

_ArraySortNum($avArray, 1)
_ArrayDisplay($avArray, "Sorted Desc starting at 1")

Func _ArraySortNum(ByRef $nArray, $Ascending = 0, $Start = 1)
For $i = $Start To UBound($nArray) - 2
Local $SE = $i

If $Ascending = 0 Then
For $x = $i To UBound($nArray) - 1
If Number($nArray[$SE]) < Number($nArray[$x]) Then $SE = $x
Next
Else
For $x = $i To UBound($nArray) - 1
If Number($nArray[$SE]) > Number($nArray[$x]) Then $SE = $x
Next
EndIf

Local $HLD = $nArray[$i]

$nArray[$i] = $nArray[$SE]

$nArray[$SE] = $HLD
Next
EndFunc ;==>_ArraySortNum
</syntaxhighlight>

[[#top | ReturnToContents]]

== _AssocArray ==

{{Snippet Header
|AuthorURL=31149-milesahead
|AuthorName=MilesAhead
}}

<syntaxhighlight lang = "autoit">
; use Scripting.Dictionary object for simple associative arrays
; with string keys. Key comparisons are case insensitive.

Global $myArray
$myArray = _AssocArray()
If @error Then
MsgBox(0x1010,"_AssocArray() Error", "Error Creating Associative Array!")
Exit
EndIf

$myArray("AntiqueWhite") = 0xFAEBD7
$myArray("Black") = 0x000000
$myArray("Blue") = 0x0000FF
$myArray("Brown") = 0xA52A2A
$myArray("CadetBlue") = 0x5F9EA0
$myArray("Chocolate") = 0xD2691E
$myArray("Coral") = 0xFF7F50

MsgBox(0x1040,"","Hex for Chocolate Color is: 0x" & Hex($myArray("Chocolate"),6))
_AssocArrayDestroy($myArray)

Func _AssocArray()
Local $aArray = ObjCreate("Scripting.Dictionary")

If @error Then
Return SetError(1, 0, 0)
EndIf

$aArray.CompareMode = 1

Return $aArray
EndFunc ;==>_AssocArray

Func _AssocArrayDestroy(ByRef $aArray)
If Not IsObj($aArray) Then
Return False
EndIf
$aArray.RemoveAll()
$aArray = 0
Return True
EndFunc ;==>_AssocArrayDestroy
</syntaxhighlight>

[[#top | ReturnToContents]]

== _FuncListToArray ==

{{Snippet Header
|AuthorURL=52-geosoft
|AuthorName=GEOSoft
}}

<syntaxhighlight lang = "autoit">
$aFlist = _FuncListToArray(@ScriptFullPath)
If NOT @Error Then
For $i = 0 To Ubound($aFlist) -1
MsgBox(0, "TEST", $aFlist[$i], 2)
Next
EndIf

Func _FuncListToArray($sStr)
If FileExists($sStr) Then $sStr = FileRead($sStr)
Local $sRegEx = "(?i)(?m:^|\n)\s*Func\s+(\w+)\s*\("
$aRegEx = StringRegExp($sStr, $sRegEx, 3)
If IsArray($aRegEx) Then Return $aRegEx
Return SetError(1)
EndFunc
</syntaxhighlight>

[[#top | ReturnToContents]]

== Identify Duplicate Values In Arrays ==

{{Snippet Header
|AuthorURL=1967-garyfrost
|AuthorName=GaryFrost
}}

<syntaxhighlight lang = "autoit">
; Identify Duplicate Values In Arrays
#include <Array.au3>

Global $a1[3] = [1, 2, 3], $a2[5] = [5, 6, 7, 8, 9], $a3[2] = [3, 5]
Global $a_a[4] = [3, $a1, $a2, $a3]
MsgBox(0, "Dupes?", _SearchForDupes($a_a))

Func _SearchForDupes($a_arrays, $i_ReturnType = 0)
Local $Dupes[1] = [0]

If $a_arrays[0] < 2 Then Return ''

For $i = 1 To $a_a[0] - 1
For $j = $i + 1 To $a_a[0]
_FindDupe($a_a[$i], $a_a[$j], $Dupes)
Next
Next

If $Dupes[0] = 0 Then Return ''

_ArraySort($Dupes)

If Not $i_ReturnType Then
Local $s_return = ''

For $x = 1 To $Dupes[0]
$s_return &= $Dupes[$x] & ','
Next
Return StringTrimRight($s_return, 1)
Else
Return $Dupes
EndIf
EndFunc ;==>_SearchForDupes

Func _FindDupe(ByRef $a_array01, ByRef $a_array02, ByRef $Dupes)
Local $found = False

For $i = 0 To UBound($a_array01) - 1
For $j = 0 To UBound($a_array02) - 1
If $a_array01[$i] = $a_array02[$j] Then
$found = False

For $x = 1 To $Dupes[0]
If $Dupes[$x] = $a_array01[$i] Then
$found = True
ExitLoop
EndIf
Next

If Not $found Then
$Dupes[0] += 1
ReDim $Dupes[$Dupes[0] + 1]
$Dupes[$Dupes[0]] = $a_array01[$i]
EndIf
EndIf
Next
Next
EndFunc ;==>_FindDupe
</syntaxhighlight>

[[#top | ReturnToContents]]

== _Is1DArray ==

{{Snippet Header
|AuthorURL=35302-guinness
|AuthorName=guinness
}}

<syntaxhighlight lang = "autoit">Local $sString = 'String'
Local $a1DArray[2] = [1, 'Row_1']
Local $a2DArray[2][2] = [[1],['Row_1: Col_1', 'Row_1: Col_2']]

ConsoleWrite('Is the variable $sString a 1D Array?: ' & _Is1DArray($sString) & @CRLF)
ConsoleWrite('Is the variable $a1DArray a 1D Array?: ' & _Is1DArray($a1DArray) & @CRLF)
ConsoleWrite('Is the variable $a2DArray a 1D Array?: ' & _Is1DArray($a2DArray) & @CRLF)

; Check if a variable is a 1D Array.
Func _Is1DArray(ByRef Const $aArray)
Return UBound($aArray) And (UBound($aArray, 0) = 1)
EndFunc ;==>_Is1DArray
</syntaxhighlight>

[[#top | ReturnToContents]]

== _Is2DArray ==

{{Snippet Header
|AuthorURL=35302-guinness
|AuthorName=guinness
|Desc=Check if a variable is a 2D Array.
}}

<syntaxhighlight lang = "autoit">Local $sString = 'String'
Local $a1DArray[2] = [1, 'Row_1']
Local $a2DArray[2][2] = [[1],['Row_1: Col_1', 'Row_1: Col_2']]

ConsoleWrite('Is the variable $sString a 1D Array?: ' & _Is2DArray($sString) & @CRLF)
ConsoleWrite('Is the variable $a1DArray a 1D Array?: ' & _Is2DArray($a1DArray) & @CRLF)
ConsoleWrite('Is the variable $a2DArray a 1D Array?: ' & _Is2DArray($a2DArray) & @CRLF)

; Check if a variable is a 2D Array.
Func _Is2DArray(ByRef Const $aArray)
Return UBound($aArray) And (UBound($aArray, 0) = 2)
EndFunc ;==>_Is2DArray
</syntaxhighlight>

[[#top | ReturnToContents]]

== _IsInBounds ==

{{Snippet Header
|AuthorURL=35302-guinness
|AuthorName=guinness
}}

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

Local $aArray[5] = ['Item_1', 'Item_2', 'Item_3', 'Item_4', 'Item_5']

ConsoleWrite(_IsInBounds($aArray, 1) & @CRLF) ; Returns True as the Array has 5 items.
ConsoleWrite(_IsInBounds($aArray, 5) & @CRLF) ; Returns False as the Array has 5 items but starts from the 0th index not 1st.
ConsoleWrite(_IsInBounds($aArray, 0) & @CRLF) ; Returns True.

If _IsInBounds($aArray, 4) Then
MsgBox($MB_SYSTEMMODAL, '', 'Position 4 contains the value: "' & $aArray[4] & '"')
EndIf

Func _IsInBounds(ByRef Const $aArray, $iIndex)
Local $iDim = UBound($aArray, 0)
If $iDim < 0 Or $iDim > 2 Then ; If not a 1D or 2D Array, then return -1 and set @error to non-zero.
Return SetError(1, 0, False)
EndIf
Return $iIndex < UBound($aArray, 1)
EndFunc ;==>_IsInBounds</syntaxhighlight>

[[#top | ReturnToContents]]

== _MultiFileListToArray ==

{{Snippet Header
|AuthorURL=4920-valuater
|AuthorName=Valuater
}}

<syntaxhighlight lang = "autoit">
; Multiple File List to Array

$Files_List = _MultiFileListToArray(@ScriptDir, "*.txt|*.ini")

; for display only
$GUI = GUICreate(" _MultiFileListToArray - DEMO")
$Edit1 = GUICtrlCreateEdit("", 50, 50, 300, 300)
For $x = 1 To UBound($Files_List) - 1
GUICtrlSetData(-1, $Files_List[$x] & @CRLF, 1)
Next
GUISetState()

While GUIGetMsg() <> -3
WEnd
; end display only

Func _MultiFileListToArray($sPath, $sFilter = "*", $iFlag = 0)
Local $hSearch, $sFile, $asFileList[1], $sCount
If Not FileExists($sPath) Then Return SetError(1, 1, "")
If (StringInStr($sFilter, "\")) Or (StringInStr($sFilter, "/")) Or (StringInStr($sFilter, ":")) Or (StringInStr($sFilter, ">")) Or (StringInStr($sFilter, "<")) Or (StringStripWS($sFilter, 8) = "") Then Return SetError(2, 2, "")
$sFilter = (StringSplit($sFilter, "|"))
If Not ($iFlag = 0 Or $iFlag = 1 Or $iFlag = 2) Then Return SetError(3, 3, "")
For $sCount = 1 To $sFilter[0]
$hSearch = FileFindFirstFile($sPath & "\" & $sFilter[$sCount])
If $hSearch = -1 Then
If $sCount = $sFilter[0] Then Return SetError(4, 4, $asFileList)
ContinueLoop
EndIf
While 1
$sFile = FileFindNextFile($hSearch)
If @error Then
SetError(0)
ExitLoop
EndIf
If $iFlag = 1 And StringInStr(FileGetAttrib($sPath & "\" & $sFile), "D") <> 0 Then ContinueLoop
If $iFlag = 2 And StringInStr(FileGetAttrib($sPath & "\" & $sFile), "D") = 0 Then ContinueLoop
ReDim $asFileList[UBound($asFileList) + 1]
$asFileList[0] = $asFileList[0] + 1
$asFileList[UBound($asFileList) - 1] = $sFile
WEnd
FileClose($hSearch)
Next
Return $asFileList
EndFunc ;==>_MultiFileListToArray
</syntaxhighlight>

[[#top | ReturnToContents]]

== Return Min or Max Number From One or Two Arrays ==

{{Snippet Header
|AuthorURL=1967-garyfrost
|AuthorName=GaryFrost
}}

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

Func _MinMaxa($a_nums01, $MaxFlag = 0, $a_nums02 = 0)
If Not IsArray($a_nums01) Then
SetError(1)
Return (0)
EndIf

If @NumParams = 3 Then
If Not IsArray($a_nums02) Then
SetError(3)
Return (0)
EndIf
EndIf

Local $idx

For $idx = 0 To UBound($a_nums01) - 1
If StringIsFloat($a_nums01[$idx]) Or StringIsInt($a_nums01[$idx]) Then
$a_nums01[$idx] = Number($a_nums01[$idx])
Else
SetError(2)
Return (0)
EndIf
Next

_ArraySort($a_nums01, $MaxFlag)

If @NumParams = 3 Then
For $idx = 0 To UBound($a_nums02) - 1
If StringIsFloat($a_nums02[$idx]) Or StringIsInt($a_nums02[$idx]) Then
$a_nums02[$idx] = Number($a_nums02[$idx])
Else
SetError(4)
Return (0)
EndIf
Next

_ArraySort($a_nums02, $MaxFlag)

If $MaxFlag Then
If Number($a_nums01[0]) > Number($a_nums02[0]) Then
Return $a_nums01[0]
Else
Return $a_nums02[0]
EndIf
Else
If Number($a_nums01[0]) < Number($a_nums02[0]) Then
Return $a_nums01[0]
Else
Return $a_nums02[0]
EndIf
EndIf
EndIf

Return $a_nums01[0]
EndFunc ;==>_MinMaxa
</syntaxhighlight>

[[#top | ReturnToContents]]

Snippets ( AutoIt Mouse & Keyboard )

2013-08-24T19:15:30Z

DatMCEyeBall: /* _MouseRepel */

__TOC__

[[category:Snippets]]

{{Snippet Credit Header}}

== Control Button by HotKey ==

{{Snippet Header
|AuthorURL=4813-smoke-n
|AuthorName=SmOke_N
|Desc=http://www.autoitscript.com/forum/index.php?s=&showtopic=36564&view=findpost&p=270412
}}

<syntaxhighlight lang="autoit">
; Control Button by HotKey
; http://www.autoitscript.com/forum/index.php?s=&showtopic=36564&view=findpost&p=270412
HotKeySet("+4", "_ClickButton")

Global Const $Main = GUICreate("Some GUI", 200, 100)

Global Const $Button = GUICtrlCreateButton("Some Button To Click", 10, 35, 180, 30)

Global $fClickit

GUISetState(@SW_SHOWNORMAL)

While 1
Switch GUIGetMsg()
Case - 3
Exit
Case $Button
If Not $fClickit Then
MsgBox(64, "Clicked", "You clicked the button")
Else
$fClickit = Not $fClickit
MsgBox(64, "Clicked", "You used a hotkey to click the button")
EndIf
EndSwitch
WEnd

Func _ClickButton()
$fClickit = Not $fClickit
ControlClick(HWnd($Main), '', $Button)
EndFunc
</syntaxhighlight>

[[#top | ReturnToContents]]

== _ControlMouseClick ==

{{Snippet Header
|AuthorURL=58637-fett8802
|AuthorName=fett8802
}}

<syntaxhighlight lang="autoit">
; #FUNCTION# ====================================================================================================================
; Name...........: _ControlMouseClick
; Description ...: Use the mouse to move to a control and click it
; Syntax.........: _ControlMouseClick($iTitle, $iText, $iControl [, $iButton = "left" [, $iClicks = "1" [, $iSpeed = "10" [, $iXpos = '' [, $iYpos = '' ]]]]] )
; Parameters ....: $iTitle - The title of the window containing the control
; $iText - Some text from the window containing the control. Can enter no text be using ''
; $iControl - The Control ID of the control to click
; $iButton - [optional] The button to click: "left", "right", "middle", "main", "menu", "primary", "secondary". Default is "left"
; $iClicks - [optional] The number of times to click the mouse. Default is 1.
; $iSpeed - [optional] The speed to move the mouse in the range 1 (fastest) to 100 (slowest). A speed of 0 will move the mouse instantly. Default speed is 10.
; $iXpos - [optional] The x position to click within the control. Default is center.
; $iYpos - [optional] The y position to click within the control. Default is center.
; Author ........: Kris Mills <fett8802 at gmail dot com>
; UserCallTip....: _ControlMouseClick ( "title", "text", controlID [, button [, clicks [, speed [, x [, y ]]]]] ) Use the mouse to move to a control and click it.(required: #include <KrisUDF.au3>)
; ===============================================================================================================================
Func _ControlMouseClick($iTitle, $iText, $iControl, $iButton = "left", $iClicks = "1", $iSpeed = "10", $iXpos = '', $iYpos = '')
$iOriginal = Opt("MouseCoordMode", 2) ;Change the MouseCoordMode to relative coords and get the previous setting
$aPos = ControlGetPos($iTitle, $iText, $iControl) ;Get the position of the given control
MouseClick($iButton, $aPos[0] + ($aPos[2] / 2) + $iXpos, $aPos[1] + ($aPos[3] / 2) + $iYpos, $iClicks, $iSpeed) ;Move the mouse and click on the given control
Opt("MouseCoordMode", $iOriginal) ;Change the MouseCoordMode back to the original
EndFunc ;==>_ControlMouseClick
</syntaxhighlight>

[[#top | ReturnToContents]]

== Get Mouse Position ==

{{Snippet Header
|AuthorURL=33528-shmuelw1
|AuthorName=shmuelw1
}}

<syntaxhighlight lang="autoit">
; This script returns the current mouse position
; Edit the value of $mode as required
#include <Misc.au3> ; required for _IsPressed

Global $mode = 0 ; this sets the MouseCoordMode - see Opt("MouseCoordMode" later in the script
Global $modeText
Global $pos

Opt("MouseCoordMode", $mode) ; 1 = absolute screen position, 0 = relative to active windows, 2 = relative to client area
Opt("TrayIconDebug", 1)

Switch $mode
Case 0
$modeText = "relative to the active window is:" & @CRLF
Case 1
$modeText = "from the top-right of the screen is:" & @CRLF
Case 2
$modeText = "relative to the client area of the active window is:" & @CRLF
EndSwitch

ToolTip("Move the pointer to the desired location. Press Enter to continue.", @DesktopWidth/2-250, @DesktopHeight/2-10)

While Not _IsPressed("0D") ; wait for Enter key
Sleep(100)
WEnd

ToolTip('') ; close ToolTip

$pos = MouseGetPos()

MsgBox(0, "Mouse Position", "The mouse position " & $modeText & $pos[0] & "," & $pos[1] & " (x,y)")
</syntaxhighlight>

[[#top | ReturnToContents]]

== Get Mouse Position With Hotkey ==

{{Snippet Header
|AuthorURL=33528-shmuelw1
|AuthorName=shmuelw1
|Desc=This script returns the current mouse position
}}

<syntaxhighlight lang="autoit">
; 2013/08/24 20:58 PM -> Code tidied by DatMCEyeBall

; This script returns the current mouse position
; Edit the value of $mode as required

#include <Misc.au3> ; required for _IsPressed

Global $mode = 0 ; this sets the MouseCoordMode - see Opt("MouseCoordMode" later in the script
Global $modeText
Global $pos

Opt("MouseCoordMode", $mode) ;1=absolute screen position, 0=relative to active windows, 2= relative to client area
Opt("TrayIconDebug", 1)

HotKeySet("^#s", "_GetPosition") ; ! = ALT keystroke, + = SHIFT, ^ = CONTROL, # = Windows key

Switch $mode
Case 0
$modeText = "relative to the active window is:" & @CRLF
Case 1
$modeText = "from the top-right of the screen is:" & @CRLF
Case 2
$modeText = "relative to the client area of the active window is:" & @CRLF
EndSwitch

While 1
Sleep(100)
WEnd

Func _GetPosition()
ToolTip("Move the pointer to the desired location. Press Enter to continue.", @DesktopWidth / 2 - 250, @DesktopHeight / 2 - 10)

While Not _IsPressed("0D") ; wait for Enter key
Sleep(100)
WEnd

ToolTip('') ; close ToolTip

$pos = MouseGetPos()

MsgBox(0, "Mouse Position", "The mouse position " & $modeText & $pos[0] & "," & $pos[1] & " (x,y)")
EndFunc ;==>_GetPosition
</syntaxhighlight>

[[#top | ReturnToContents]]

== _IsLeftHandedMouse ==

{{Snippet Header
|AuthorURL=35302-guinness
|AuthorName=guinness
}}

<syntaxhighlight lang="autoit">
#include <WinAPI.au3>
#include <WindowsConstants.au3>

ConsoleWrite( _IsLeftHandedMouse() & @CRLF)

Func _IsLeftHandedMouse()
Return _WinAPI_GetSystemMetrics($SM_SWAPBUTTON) > 0
EndFunc ;==>_IsLeftHandedMouse
</syntaxhighlight>

[[#top | ReturnToContents]]

== _IsRightHandedMouse ==

{{Snippet Header
|AuthorURL=35302-guinness
|AuthorName=guinness
}}

<syntaxhighlight lang="autoit">
#include <WinAPI.au3>
#include <WindowsConstants.au3>

#include <WinAPI.au3>
#include <WindowsConstants.au3>

MsgBox(64, "_IsRightHandedMouse()", _IsRightHandedMouse())

Func _IsRightHandedMouse()
Return _WinAPI_GetSystemMetrics($SM_SWAPBUTTON) = 0
EndFunc ;==>_IsRightHandedMouse
</syntaxhighlight>

[[#top | ReturnToContents]]

== Is Mouse Over GUI ==

{{Snippet Header
|AuthorURL=20477-mrcreator
|AuthorName=MrCreatoR
|ModifierURL=4920-valuater
|ModifierName=Valuater
|Desc=Check if Mouse is over a GUI
}}

<syntaxhighlight lang="autoit">
; Check if Mouse is over a GUI

#include <GUIConstants.au3>

Global $ParentWin = GUICreate("GetHoveredHwnd")

GUISetState(@SW_SHOWNORMAL)

While 1
If GUIGetMsg() = -3 Then Exit

If GetHoveredHwnd() = $ParentWin Then
ToolTip("You are over the GUI")
Else
ToolTip('')
EndIf
WEnd

Func GetHoveredHwnd()
Local $iRet = DllCall("user32.dll", "int", "WindowFromPoint", "long", MouseGetPos(0), "long", MouseGetPos(1))
If IsArray($iRet) Then Return HWnd($iRet[0])
Return SetError(1, 0, 0)
EndFunc
</syntaxhighlight>

[[#top | ReturnToContents]]

== _IsMouseInstalled ==

{{Snippet Header
|AuthorURL=35302-guinness
|AuthorName=guinness
}}

<syntaxhighlight lang="autoit">
#include <WinAPI.au3>
#include <WindowsConstants.au3>

MsgBox(64, "_IsMouseInstalled()", _IsMouseInstalled())

Func _IsMouseInstalled()
Return _WinAPI_GetSystemMetrics($SM_CMOUSEBUTTONS) > 0
EndFunc ;==>_IsMouseInstalled
</syntaxhighlight>

[[#top | ReturnToContents]]

== _IsMouseWheelPresent ==

{{Snippet Header
|AuthorURL=35302-guinness
|AuthorName=guinness
}}

<syntaxhighlight lang="autoit">
#include <WinAPI.au3>
#include <WindowsConstants.au3>

ConsoleWrite(_IsMouseWheelPresent() & @CRLF)

Func _IsMouseWheelPresent()
Return _WinAPI_GetSystemMetrics($SM_MOUSEWHEELPRESENT) > 0
EndFunc ;==>_IsMouseWheelPresent
</syntaxhighlight>

[[#top | ReturnToContents]]

== _MouseRepel ==

{{Snippet Header
|AuthorURL=6946-the-kandie-man
|AuthorName=The Kandie Man
|ModifierURL=79729-datmceyeball
|ModifierName=DatMCEyeBall
|Desc=Mouse repel - keep mouse away from an area
}}

<syntaxhighlight lang="autoit">
; GUI snap to corners
; Mouse repel - keep mouse away from an area
; Author - The Kandie Man
; 2013/08/24 21:11 PM -> Modified for GUI, left in the AdlibRegister for non-GUI uses -> DatMCEyeBall.

#include <WindowsConstants.au3> ;For the $WM_NOTIFY const.

Global Const $GUI = GUICreate("Can't Touch This", 200, 100, 200, 200)

GUISetState(@SW_SHOWNORMAL)

; AdlibRegister("CallMouseRepel", 10) ; Use for non-GUI purposes.
GUIRegisterMsg($WM_MOUSEMOVE, "CallMouseRepel") ;Cleaner way of doing it for a GUI.

While 1
$nMsg = GUIGetMsg()
If $nMsg = -3 Then Exit
WEnd

Func CallMouseRepel()
Local Const $coords = WinGetPos($GUI)
_MouseRepel($coords[0], $coords[1], $coords[0] + $coords[2], $coords[1] + $coords[3])
EndFunc ;==>CallMouseRepel

;===============================================================================
; Description: _MouseRepel
; Parameter(s): $i_left - Left coord
; $i_top - Top coord
; $i_right - Right coord
; $i_bottom - Bottom coord
; User CallTip: _MouseRepel([$i_left = 0[, $i_top = 0[, $i_right = 0[, $i_bottom = 0]]]]) Repel the Mouse Cursor to specified coords.
; Author(s): The Kandie Man
; Note(s): This function must be called constantly to prevent the mouse cursor from entering the area.
; It is therefore recommended that you call this function from another function that is called by AdlibEnable every 1 to 50ms.
;===============================================================================
Func _MouseRepel($i_left = 0, $i_top = 0, $i_right = 0, $i_bottom = 0)
Local $a_MousePos = MouseGetPos()

Local $i_XCordinate = -1, $i_YCordinate = -1

If $a_MousePos[0] >= $i_left And $a_MousePos[0] <= $i_right Then
If ($a_MousePos[0] - $i_left) < ($i_right - $a_MousePos[0]) Then
$i_XCordinate = $i_left - 1
Else
$i_XCordinate = $i_right + 1
EndIf
EndIf

If $a_MousePos[1] >= $i_top And $a_MousePos[1] <= $i_bottom Then
If ($a_MousePos[1] - $i_top) < ($i_bottom - $a_MousePos[1]) Then
$i_YCordinate = $i_top - 1
Else
$i_YCordinate = $i_bottom + 1
EndIf
EndIf

If $i_XCordinate <> -1 And $i_YCordinate <> -1 Then
If Abs($i_XCordinate - $a_MousePos[0]) > Abs($i_YCordinate - $a_MousePos[1]) Then
MouseMove($a_MousePos[0], $i_YCordinate, 1)
ElseIf Abs($i_XCordinate - $a_MousePos[0]) < Abs($i_YCordinate - $a_MousePos[1]) Then
MouseMove($i_XCordinate, $a_MousePos[1], 1)
Else
MouseMove($i_XCordinate, $i_YCordinate, 1)
EndIf
EndIf
EndFunc ;==>_MouseRepel
</syntaxhighlight>

[[#top | ReturnToContents]]

== _MyMouseMove ==

{{Snippet Header
|AuthorURL=3602-martin
|AuthorName=martin
}}

<syntaxhighlight lang="autoit">
; Work with any screen resolution
; This is for the 1440 x 900 screen - change as needed

Global Const $iHeight = 900
Global Const $iWidth = 1440

_MyMouseMove(100, 200)

Func _MyMouseMove($iX, $iY)
Return MouseMove(@DesktopWidth * $iX / $iWidth, @DesktopHeight * $iY / $iHeight)
EndFunc ;==>_MyMouseMove
</syntaxhighlight>

[[#top | ReturnToContents]]

== Restricted Input Keys - All USB Devices ==

{{Snippet Header
|AuthorName=Multiple Authors
}}

<syntaxhighlight lang="autoit">
#include <GUIConstantsEx.au3>
#include <WindowsConstants.au3>

Global $iInput = 99

; Restricted keys in an input "[\/:*?"<>\|]"

Example()

Func Example()
Local Const $hGUI = GUICreate("Input Filter", 300, 30, -1, -1)

$iInput = GUICtrlCreateInput('', 5, 5, 290)

GUIRegisterMsg($WM_COMMAND, "WM_COMMAND")

GUISetState(@SW_SHOWNORMAL, $hGUI)

While 1
Switch GUIGetMsg()
Case $GUI_EVENT_CLOSE
ExitLoop
EndSwitch
WEnd

GUIDelete($hGUI)
EndFunc ;==>Example

Func WM_COMMAND($hWnd, $iMsg, $wParam, $lParam)
#forceref $hWnd, $iMsg, $wParam, $lParam
Return GUICtrlSetData($iInput, StringRegExpReplace(GUICtrlRead($iInput), '[\\/ :* ?"<>\|]', ''))
EndFunc ;==>WM_COMMAND
</syntaxhighlight>

[[#top | ReturnToContents]]

== Two Tray Mouse Menus ==

{{Snippet Header
|AuthorURL=13029-smashly
|AuthorName=smashly
}}

<syntaxhighlight lang="autoit">
; Two Tray Menus - Right & Left Click On Icon

#include <Constants.au3>

Opt("TrayOnEventMode",1)
Opt("TrayMenuMode",1)

TraySetClick(18)

Global $Tray[11], $state = 2

TrayCreateItem('')
TrayCreateItem("Exit")
TrayItemSetOnEvent(-1, "TrayEvent")
TraySetOnEvent($TRAY_EVENT_PRIMARYDOWN, "TrayMenuLeftClick")
TraySetOnEvent($TRAY_EVENT_SECONDARYDOWN, "TrayMenuRightClick")
TraySetState()

While 1
Sleep(100)
WEnd

Func TrayMenuLeftClick()
If $state = 0 Or $state = 2 Then
$state = 1
For $i = 6 to 10
TrayItemDelete($Tray[$i])
Next
For $i = 1 to 5
$Tray[$i] = TrayCreateItem("1st Menu Item - " & $i, -1, $i -1 )
TrayItemSetOnEvent(-1, "TrayEvent")
Next
EndIf
EndFunc

Func TrayMenuRightClick()
If $state = 1 Or $state = 2 Then
$state = 0
For $i = 1 to 5
TrayItemDelete($Tray[$i])
Next
For $i = 6 to 10
$Tray[$i] = TrayCreateItem("2nd Menu Item - " & $i - 5, -1, $i - 6)
TrayItemSetOnEvent(-1, "TrayEvent")
Next
EndIf
EndFunc

Func TrayEvent()
MsgBox(0, '', TrayItemGetText(@TRAY_ID))
If TrayItemGetText(@TRAY_ID) = "Exit" Then Exit
EndFunc
</syntaxhighlight>

[[#top | ReturnToContents]]

== _WinAPI_SwapMouseButton ==

{{Snippet Header
|AuthorURL=35302-guinness
|AuthorName=guinness
}}

<syntaxhighlight lang="autoit">
Example()

Func Example()
; Swap the left button to generate right-button messages and vice versa.
ConsoleWrite(_WinAPI_SwapMouseButton(True) & @CRLF)

; Wait for the user to see the changes.
Sleep(10000)

; Change the mouse buttons back to their original meanings.
ConsoleWrite(_WinAPI_SwapMouseButton(False) & @CRLF)
EndFunc ;==>Example

; If $fFlag is True, the left button generates right-button messages and the right button generates left-button messages.
; If $fFlag is False, the buttons are restored to their original meanings.
Func _WinAPI_SwapMouseButton($fFlag)
Local $aReturn = DllCall('user32.dll', 'int', 'SwapMouseButton', 'int', $fFlag)
If @error Then
Return SetError(1, 0, 0)
EndIf
Return $aReturn[0]
EndFunc ;==>_WinAPI_SwapMouseButton
</syntaxhighlight>

[[#top | ReturnToContents]]

Snippets ( AutoIt Mouse & Keyboard )

2013-08-24T19:14:15Z

DatMCEyeBall: /* _MouseRepel */

Snippets ( AutoIt Mouse & Keyboard )

2013-08-24T18:59:59Z

DatMCEyeBall: /* Get Mouse Position With Hotkey */

__TOC__

[[category:Snippets]]

{{Snippet Credit Header}}

== Control Button by HotKey ==

{{Snippet Header
|AuthorURL=4813-smoke-n
|AuthorName=SmOke_N
|Desc=http://www.autoitscript.com/forum/index.php?s=&showtopic=36564&view=findpost&p=270412
}}

<syntaxhighlight lang="autoit">
; Control Button by HotKey
; http://www.autoitscript.com/forum/index.php?s=&showtopic=36564&view=findpost&p=270412
HotKeySet("+4", "_ClickButton")

Global Const $Main = GUICreate("Some GUI", 200, 100)

Global Const $Button = GUICtrlCreateButton("Some Button To Click", 10, 35, 180, 30)

Global $fClickit

GUISetState(@SW_SHOWNORMAL)

While 1
Switch GUIGetMsg()
Case - 3
Exit
Case $Button
If Not $fClickit Then
MsgBox(64, "Clicked", "You clicked the button")
Else
$fClickit = Not $fClickit
MsgBox(64, "Clicked", "You used a hotkey to click the button")
EndIf
EndSwitch
WEnd

Func _ClickButton()
$fClickit = Not $fClickit
ControlClick(HWnd($Main), '', $Button)
EndFunc
</syntaxhighlight>

[[#top | ReturnToContents]]

== _ControlMouseClick ==

{{Snippet Header
|AuthorURL=58637-fett8802
|AuthorName=fett8802
}}

<syntaxhighlight lang="autoit">
; #FUNCTION# ====================================================================================================================
; Name...........: _ControlMouseClick
; Description ...: Use the mouse to move to a control and click it
; Syntax.........: _ControlMouseClick($iTitle, $iText, $iControl [, $iButton = "left" [, $iClicks = "1" [, $iSpeed = "10" [, $iXpos = '' [, $iYpos = '' ]]]]] )
; Parameters ....: $iTitle - The title of the window containing the control
; $iText - Some text from the window containing the control. Can enter no text be using ''
; $iControl - The Control ID of the control to click
; $iButton - [optional] The button to click: "left", "right", "middle", "main", "menu", "primary", "secondary". Default is "left"
; $iClicks - [optional] The number of times to click the mouse. Default is 1.
; $iSpeed - [optional] The speed to move the mouse in the range 1 (fastest) to 100 (slowest). A speed of 0 will move the mouse instantly. Default speed is 10.
; $iXpos - [optional] The x position to click within the control. Default is center.
; $iYpos - [optional] The y position to click within the control. Default is center.
; Author ........: Kris Mills <fett8802 at gmail dot com>
; UserCallTip....: _ControlMouseClick ( "title", "text", controlID [, button [, clicks [, speed [, x [, y ]]]]] ) Use the mouse to move to a control and click it.(required: #include <KrisUDF.au3>)
; ===============================================================================================================================
Func _ControlMouseClick($iTitle, $iText, $iControl, $iButton = "left", $iClicks = "1", $iSpeed = "10", $iXpos = '', $iYpos = '')
$iOriginal = Opt("MouseCoordMode", 2) ;Change the MouseCoordMode to relative coords and get the previous setting
$aPos = ControlGetPos($iTitle, $iText, $iControl) ;Get the position of the given control
MouseClick($iButton, $aPos[0] + ($aPos[2] / 2) + $iXpos, $aPos[1] + ($aPos[3] / 2) + $iYpos, $iClicks, $iSpeed) ;Move the mouse and click on the given control
Opt("MouseCoordMode", $iOriginal) ;Change the MouseCoordMode back to the original
EndFunc ;==>_ControlMouseClick
</syntaxhighlight>

[[#top | ReturnToContents]]

== Get Mouse Position ==

{{Snippet Header
|AuthorURL=33528-shmuelw1
|AuthorName=shmuelw1
}}

<syntaxhighlight lang="autoit">
; This script returns the current mouse position
; Edit the value of $mode as required
#include <Misc.au3> ; required for _IsPressed

Global $mode = 0 ; this sets the MouseCoordMode - see Opt("MouseCoordMode" later in the script
Global $modeText
Global $pos

Opt("MouseCoordMode", $mode) ; 1 = absolute screen position, 0 = relative to active windows, 2 = relative to client area
Opt("TrayIconDebug", 1)

Switch $mode
Case 0
$modeText = "relative to the active window is:" & @CRLF
Case 1
$modeText = "from the top-right of the screen is:" & @CRLF
Case 2
$modeText = "relative to the client area of the active window is:" & @CRLF
EndSwitch

ToolTip("Move the pointer to the desired location. Press Enter to continue.", @DesktopWidth/2-250, @DesktopHeight/2-10)

While Not _IsPressed("0D") ; wait for Enter key
Sleep(100)
WEnd

ToolTip('') ; close ToolTip

$pos = MouseGetPos()

MsgBox(0, "Mouse Position", "The mouse position " & $modeText & $pos[0] & "," & $pos[1] & " (x,y)")
</syntaxhighlight>

[[#top | ReturnToContents]]

== Get Mouse Position With Hotkey ==

{{Snippet Header
|AuthorURL=33528-shmuelw1
|AuthorName=shmuelw1
|Desc=This script returns the current mouse position
}}

<syntaxhighlight lang="autoit">
; 2013/08/24 20:58 PM -> Code tidied by DatMCEyeBall

; This script returns the current mouse position
; Edit the value of $mode as required

#include <Misc.au3> ; required for _IsPressed

Global $mode = 0 ; this sets the MouseCoordMode - see Opt("MouseCoordMode" later in the script
Global $modeText
Global $pos

Opt("MouseCoordMode", $mode) ;1=absolute screen position, 0=relative to active windows, 2= relative to client area
Opt("TrayIconDebug", 1)

HotKeySet("^#s", "_GetPosition") ; ! = ALT keystroke, + = SHIFT, ^ = CONTROL, # = Windows key

Switch $mode
Case 0
$modeText = "relative to the active window is:" & @CRLF
Case 1
$modeText = "from the top-right of the screen is:" & @CRLF
Case 2
$modeText = "relative to the client area of the active window is:" & @CRLF
EndSwitch

While 1
Sleep(100)
WEnd

Func _GetPosition()
ToolTip("Move the pointer to the desired location. Press Enter to continue.", @DesktopWidth / 2 - 250, @DesktopHeight / 2 - 10)

While Not _IsPressed("0D") ; wait for Enter key
Sleep(100)
WEnd

ToolTip('') ; close ToolTip

$pos = MouseGetPos()

MsgBox(0, "Mouse Position", "The mouse position " & $modeText & $pos[0] & "," & $pos[1] & " (x,y)")
EndFunc ;==>_GetPosition
</syntaxhighlight>

[[#top | ReturnToContents]]

== _IsLeftHandedMouse ==

{{Snippet Header
|AuthorURL=35302-guinness
|AuthorName=guinness
}}

<syntaxhighlight lang="autoit">
#include <WinAPI.au3>
#include <WindowsConstants.au3>

ConsoleWrite( _IsLeftHandedMouse() & @CRLF)

Func _IsLeftHandedMouse()
Return _WinAPI_GetSystemMetrics($SM_SWAPBUTTON) > 0
EndFunc ;==>_IsLeftHandedMouse
</syntaxhighlight>

[[#top | ReturnToContents]]

== _IsRightHandedMouse ==

{{Snippet Header
|AuthorURL=35302-guinness
|AuthorName=guinness
}}

<syntaxhighlight lang="autoit">
#include <WinAPI.au3>
#include <WindowsConstants.au3>

#include <WinAPI.au3>
#include <WindowsConstants.au3>

MsgBox(64, "_IsRightHandedMouse()", _IsRightHandedMouse())

Func _IsRightHandedMouse()
Return _WinAPI_GetSystemMetrics($SM_SWAPBUTTON) = 0
EndFunc ;==>_IsRightHandedMouse
</syntaxhighlight>

[[#top | ReturnToContents]]

== Is Mouse Over GUI ==

{{Snippet Header
|AuthorURL=20477-mrcreator
|AuthorName=MrCreatoR
|ModifierURL=4920-valuater
|ModifierName=Valuater
|Desc=Check if Mouse is over a GUI
}}

<syntaxhighlight lang="autoit">
; Check if Mouse is over a GUI

#include <GUIConstants.au3>

Global $ParentWin = GUICreate("GetHoveredHwnd")

GUISetState(@SW_SHOWNORMAL)

While 1
If GUIGetMsg() = -3 Then Exit

If GetHoveredHwnd() = $ParentWin Then
ToolTip("You are over the GUI")
Else
ToolTip('')
EndIf
WEnd

Func GetHoveredHwnd()
Local $iRet = DllCall("user32.dll", "int", "WindowFromPoint", "long", MouseGetPos(0), "long", MouseGetPos(1))
If IsArray($iRet) Then Return HWnd($iRet[0])
Return SetError(1, 0, 0)
EndFunc
</syntaxhighlight>

[[#top | ReturnToContents]]

== _IsMouseInstalled ==

{{Snippet Header
|AuthorURL=35302-guinness
|AuthorName=guinness
}}

<syntaxhighlight lang="autoit">
#include <WinAPI.au3>
#include <WindowsConstants.au3>

MsgBox(64, "_IsMouseInstalled()", _IsMouseInstalled())

Func _IsMouseInstalled()
Return _WinAPI_GetSystemMetrics($SM_CMOUSEBUTTONS) > 0
EndFunc ;==>_IsMouseInstalled
</syntaxhighlight>

[[#top | ReturnToContents]]

== _IsMouseWheelPresent ==

{{Snippet Header
|AuthorURL=35302-guinness
|AuthorName=guinness
}}

<syntaxhighlight lang="autoit">
#include <WinAPI.au3>
#include <WindowsConstants.au3>

ConsoleWrite(_IsMouseWheelPresent() & @CRLF)

Func _IsMouseWheelPresent()
Return _WinAPI_GetSystemMetrics($SM_MOUSEWHEELPRESENT) > 0
EndFunc ;==>_IsMouseWheelPresent
</syntaxhighlight>

[[#top | ReturnToContents]]

== _MouseRepel ==

{{Snippet Header
|AuthorURL=6946-the-kandie-man
|AuthorName=The Kandie Man
|Desc=Mouse repel - keep mouse away from an area
}}

<syntaxhighlight lang="autoit">
; GUI snap to corners
; Mouse repel - keep mouse away from an area
; Author - The Kandie Man

Global Const $GUI = GUICreate("Can't Touch This", 200, 100, 200, 200)

GUISetState(@SW_SHOWNORMAL)

AdlibRegister("CallMouseRepel", 10)

While 1
Sleep(1000)
WEnd

Func CallMouseRepel()
Local Const $coords = WinGetPos($GUI)
_MouseRepel($coords[0], $coords[1], $coords[0] + $coords[2], $coords[1] + $coords[3])
EndFunc ;==>CallMouseRepel

;===============================================================================
; Description: _MouseRepel
; Parameter(s): $i_left - Left coord
; $i_top - Top coord
; $i_right - Right coord
; $i_bottom - Bottom coord
; User CallTip: _MouseRepel([$i_left = 0[, $i_top = 0[, $i_right = 0[, $i_bottom = 0]]]]) Repel the Mouse Cursor to specified coords.
; Author(s): The Kandie Man
; Note(s): This function must be called constantly to prevent the mouse cursor from entering the area.
; It is therefore recommended that you call this function from another function that is called by AdlibEnable every 1 to 50ms.
;===============================================================================
Func _MouseRepel($i_left = 0, $i_top = 0, $i_right = 0, $i_bottom = 0)
Local $a_MousePos = MouseGetPos()

Local $i_XCordinate = -1, $i_YCordinate = -1

If $a_MousePos[0] >= $i_left And $a_MousePos[0] <= $i_right Then
If ($a_MousePos[0] - $i_left) < ($i_right - $a_MousePos[0]) Then
$i_XCordinate = $i_left - 1
Else
$i_XCordinate = $i_right + 1
EndIf
EndIf

If $a_MousePos[1] >= $i_top And $a_MousePos[1] <= $i_bottom Then
If ($a_MousePos[1] - $i_top) < ($i_bottom - $a_MousePos[1]) Then
$i_YCordinate = $i_top - 1
Else
$i_YCordinate = $i_bottom + 1
EndIf
EndIf

If $i_XCordinate <> -1 And $i_YCordinate <> -1 Then
If Abs($i_XCordinate - $a_MousePos[0]) > Abs($i_YCordinate - $a_MousePos[1]) Then
MouseMove($a_MousePos[0], $i_YCordinate, 1)
ElseIf Abs($i_XCordinate - $a_MousePos[0]) < Abs($i_YCordinate - $a_MousePos[1]) Then
MouseMove($i_XCordinate, $a_MousePos[1], 1)
Else
MouseMove($i_XCordinate, $i_YCordinate, 1)
EndIf
EndIf
EndFunc ;==>_MouseRepel
</syntaxhighlight>

[[#top | ReturnToContents]]

== _MyMouseMove ==

{{Snippet Header
|AuthorURL=3602-martin
|AuthorName=martin
}}

<syntaxhighlight lang="autoit">
; Work with any screen resolution
; This is for the 1440 x 900 screen - change as needed

Global Const $iHeight = 900
Global Const $iWidth = 1440

_MyMouseMove(100, 200)

Func _MyMouseMove($iX, $iY)
Return MouseMove(@DesktopWidth * $iX / $iWidth, @DesktopHeight * $iY / $iHeight)
EndFunc ;==>_MyMouseMove
</syntaxhighlight>

[[#top | ReturnToContents]]

== Restricted Input Keys - All USB Devices ==

{{Snippet Header
|AuthorName=Multiple Authors
}}

<syntaxhighlight lang="autoit">
#include <GUIConstantsEx.au3>
#include <WindowsConstants.au3>

Global $iInput = 99

; Restricted keys in an input "[\/:*?"<>\|]"

Example()

Func Example()
Local Const $hGUI = GUICreate("Input Filter", 300, 30, -1, -1)

$iInput = GUICtrlCreateInput('', 5, 5, 290)

GUIRegisterMsg($WM_COMMAND, "WM_COMMAND")

GUISetState(@SW_SHOWNORMAL, $hGUI)

While 1
Switch GUIGetMsg()
Case $GUI_EVENT_CLOSE
ExitLoop
EndSwitch
WEnd

GUIDelete($hGUI)
EndFunc ;==>Example

Func WM_COMMAND($hWnd, $iMsg, $wParam, $lParam)
#forceref $hWnd, $iMsg, $wParam, $lParam
Return GUICtrlSetData($iInput, StringRegExpReplace(GUICtrlRead($iInput), '[\\/ :* ?"<>\|]', ''))
EndFunc ;==>WM_COMMAND
</syntaxhighlight>

[[#top | ReturnToContents]]

== Two Tray Mouse Menus ==

{{Snippet Header
|AuthorURL=13029-smashly
|AuthorName=smashly
}}

<syntaxhighlight lang="autoit">
; Two Tray Menus - Right & Left Click On Icon

#include <Constants.au3>

Opt("TrayOnEventMode",1)
Opt("TrayMenuMode",1)

TraySetClick(18)

Global $Tray[11], $state = 2

TrayCreateItem('')
TrayCreateItem("Exit")
TrayItemSetOnEvent(-1, "TrayEvent")
TraySetOnEvent($TRAY_EVENT_PRIMARYDOWN, "TrayMenuLeftClick")
TraySetOnEvent($TRAY_EVENT_SECONDARYDOWN, "TrayMenuRightClick")
TraySetState()

While 1
Sleep(100)
WEnd

Func TrayMenuLeftClick()
If $state = 0 Or $state = 2 Then
$state = 1
For $i = 6 to 10
TrayItemDelete($Tray[$i])
Next
For $i = 1 to 5
$Tray[$i] = TrayCreateItem("1st Menu Item - " & $i, -1, $i -1 )
TrayItemSetOnEvent(-1, "TrayEvent")
Next
EndIf
EndFunc

Func TrayMenuRightClick()
If $state = 1 Or $state = 2 Then
$state = 0
For $i = 1 to 5
TrayItemDelete($Tray[$i])
Next
For $i = 6 to 10
$Tray[$i] = TrayCreateItem("2nd Menu Item - " & $i - 5, -1, $i - 6)
TrayItemSetOnEvent(-1, "TrayEvent")
Next
EndIf
EndFunc

Func TrayEvent()
MsgBox(0, '', TrayItemGetText(@TRAY_ID))
If TrayItemGetText(@TRAY_ID) = "Exit" Then Exit
EndFunc
</syntaxhighlight>

[[#top | ReturnToContents]]

== _WinAPI_SwapMouseButton ==

{{Snippet Header
|AuthorURL=35302-guinness
|AuthorName=guinness
}}

<syntaxhighlight lang="autoit">
Example()

Func Example()
; Swap the left button to generate right-button messages and vice versa.
ConsoleWrite(_WinAPI_SwapMouseButton(True) & @CRLF)

; Wait for the user to see the changes.
Sleep(10000)

; Change the mouse buttons back to their original meanings.
ConsoleWrite(_WinAPI_SwapMouseButton(False) & @CRLF)
EndFunc ;==>Example

; If $fFlag is True, the left button generates right-button messages and the right button generates left-button messages.
; If $fFlag is False, the buttons are restored to their original meanings.
Func _WinAPI_SwapMouseButton($fFlag)
Local $aReturn = DllCall('user32.dll', 'int', 'SwapMouseButton', 'int', $fFlag)
If @error Then
Return SetError(1, 0, 0)
EndIf
Return $aReturn[0]
EndFunc ;==>_WinAPI_SwapMouseButton
</syntaxhighlight>

[[#top | ReturnToContents]]

Snippets ( AutoIt Array )

2013-08-24T18:52:39Z

DatMCEyeBall: /* _ArrayEmpty */

__TOC__

[[category:Snippets]]

{{Snippet Credit Header}}

== _1Dto2DArray ==

{{Snippet Header
|AuthorURL=35302-guinness
|AuthorName=guinness
}}

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

Global $aArray_1D[2] = ["Data", "Data"]
_ArrayDisplay($aArray_1D)
_1Dto2DArray($aArray_1D)
_ArrayDisplay($aArray_1D)

Global $aArray_1D[10] = ["Data", "Data", "Data", "Data", "Data", "Data", "Data", "Data", "Data", "Data"]
_ArrayDisplay($aArray_1D)
_1Dto2DArray($aArray_1D, 9)
_ArrayDisplay($aArray_1D)

Func _1Dto2DArray(ByRef $aArray, Const $iAdditionalColumns = 1)
Local Const $iSize = UBound($aArray, 1)

Local $aReturn[$iSize][$iAdditionalColumns + 1]

For $A = 0 To $iSize - 1
$aReturn[$A][0] = $aArray[$A]
Next

$aArray = $aReturn

Return $aReturn
EndFunc ;==>_1Dto2DArray
</syntaxhighlight>

[[#top | ReturnToContents]]

== _ArrayAddEx ==

{{Snippet Header
|AuthorURL=35302-guinness
|AuthorName=guinness
}}

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

Example_1()
Example_2()

Func Example_1()
Local $aArray_1[1] = ["Data_0"], $iBegin

$iBegin = TimerInit() ; Start the timer.
For $i = 1 To 5000
_ArrayAdd($aArray_1, "Data_" & $i)
Next
$iBegin = TimerDiff($iBegin) ; End the timer and find the difference from start to finish.
ConsoleWrite("_ArrayAdd from Array.au3 >> " & $iBegin & @CRLF)
_ArrayDisplay($aArray_1)
EndFunc ;==>Example_1

Func Example_2()
Local $aArray_2[1] = ["Data_0"], $iBegin, $iDimension, $iCount

$iBegin = TimerInit() ; Start the timer.
For $i = 1 To 5000
_ArrayAddEx($aArray_2, "Data_" & $i, $iDimension, $iCount) ; $iDimension is the overall size of the array & $iCount is the last index number, because regarding the overall size +1 as the next item will give false results as we're increasing the size of the array not by 1 but multiplying 2.
Next
$iBegin = TimerDiff($iBegin) ; End the timer and find the difference from start to finish.
ConsoleWrite("_ArrayAddEx by guinness >> " & $iBegin & @CRLF)
ReDim $aArray_2[$iCount] ; Remove the empty rows.
_ArrayDisplay($aArray_2)
EndFunc ;==>Example_2

Func _ArrayAddEx(ByRef $aArray, $sData, ByRef $iDimension, ByRef $iCount) ; Taken from Array.au3 and modified by guinness to reduce the use of ReDim.
If IsArray($aArray) = 0 Then
Return SetError(1, 0, -1)
EndIf

If UBound($aArray, 0) <> 1 Then
Return SetError(2, 0, -1)
EndIf

If $iCount = 0 Then
$iCount = UBound($aArray, 1)
EndIf

$iCount += 1
If ($iCount + 1) >= $iDimension Then
$iDimension = (UBound($aArray, 1) + 1) * 2
ReDim $aArray[$iDimension]
EndIf
$aArray[$iCount - 1] = $sData
Return $iCount - 1
EndFunc ;==>_ArrayAddEx
</syntaxhighlight>

[[#top | ReturnToContents]]

== _ArrayEmpty ==

{{Snippet Header
|AuthorURL=35302-guinness
|AuthorName=guinness
|Desc=Creates Empty 1D & 2D Array's
}}

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

Global $aMain[11] = [10]
_ArrayEmpty($aMain)
_ArrayDisplay($aMain, "Empty 1D Array.")

Global $aMainEx[11][3] = [[10]]
_ArrayEmpty($aMainEx)
_ArrayDisplay($aMainEx, "Empty 2D Array.")

Func _ArrayEmpty(ByRef $aArray)
Switch UBound($aArray, 0) ; Dimension, 1D or 2D array are supported.
Case 1
Local $aEmpty1D[1]
$aArray = $aEmpty1D

Case 2
; Edit by DatMCEyeBall - Instead of emptying the array to [1][$x] we empty it to [$x][$y]
; where $x is the 1st dimensions size and $y the 2nd.
; Previous code was: Local $aEmpty2D[1][UBound($aArray, 2)]
Local $aEmpty2D[UBound($aArray, 1)][UBound($aArray, 2)]
$aArray = $aEmpty2D
EndSwitch
EndFunc ;==>_ArrayEmpty
</syntaxhighlight>

[[#top | ReturnToContents]]

== _ArrayGet ==

{{Snippet Header
|AuthorURL=31965-progandy
|AuthorName=ProgAndy
|Desc=Easy access for nested arrays up to 20 nested dimensions (including multidimensional arrays)
}}

<syntaxhighlight lang = "autoit">
Global $b[2] = ["a", "b"]
Global $a[3][2] = [[0, -1], [$b, "x"], [1, -2]]

Global $c[5] = [11, 22, 33, 44, 55]

MsgBox(0, "", _ArrayGet($a, 1, 0, 1) & " # " & @error)

; #FUNCTION# ====================================================================================================================
; Name ..........: _ArrayGet
; Description ...: Gets a value from a nested multidimensional array
; Syntax ........: _ArrayGet(Byref $aArray, $i1[, $i2 = 0[, $i3 = 0[, $i4 = 0[, $i5 = 0[, $i6 = 0[, $i7 = 0[, $i8 = 0[,
; $i9 = 0[, $i10 = 0[, $i11 = 0[, $i12 = 0[, $i13 = 0[, $i14 = 0[, $i15 = 0[, $i16 = 0[, $i17 = 0[,
; $i18 = 0[, $i19 = 0[, $i20 = 0]]]]]]]]]]]]]]]]]]])
; Parameters ....: $aArray - [in/out] An array of unknowns.
; $i1 - first array index.
; $i2 - [optional] second array index.
; $i3 - [optional] third array index.
; $i4 - [optional] fourth array index.
; $i5 - [optional] fifth array index.
; $i6 - [optional] sixth array index.
; $i7 - [optional] seventh array index.
; $i8 - [optional] eighth array index.
; $i9 - [optional] ninth array index.
; $i10 - [optional] 10th array index.
; $i11 - [optional] 11th array index.
; $i12 - [optional] 12th array index.
; $i13 - [optional] 13th array index.
; $i14 - [optional] 14th array index.
; $i15 - [optional] 15th array index.
; $i16 - [optional] 16th array index.
; $i17 - [optional] 17th array index.
; $i18 - [optional] 18th array index.
; $i19 - [optional] 19th array index.
; $i20 - [optional] 20th array index.
; Return values .: Success: Value at the specified index
; Error: Nothing, Sets @error to:
; |1 - Trying to acces non-array as array
; |2 - Not enough dimensions for the last accessed array
; |3 - Index out of bounds for a dimension
; @extended contains the dimension in error (according to parameter list)
; Author ........: ProgAndy
; Modified ......:
; Remarks .......:
; Related .......:
; Link ..........:
; Example .......: No
; ===============================================================================================================================
Func _ArrayGet(ByRef $aArray, $i1, $i2=0, $i3=0, $i4=0, $i5=0, $i6=0, $i7=0, $i8=0, $i9=0, $i10=0, $i11=0, $i12=0, $i13=0, $i14=0, $i15=0, $i16=0, $i17=0, $i18=0, $i19=0, $i20=0)
#forceref $i1, $i2, $i3, $i4, $i5, $i6, $i7, $i8, $i9, $i10, $i11, $i12, $i13, $i14, $i15, $i16, $i17, $i18, $i19, $i20
; ProgAndy
Local $NULL
If Not IsArray($aArray) Then Return SetError(1, 1, $NULL)
Local $iDims = UBound($aArray, 0)
If @NumParams <= $iDims Then Return SetError(2, @NumParams, $NULL)
Local $sAccess = "$aArray"
For $i = 1 To $iDims
Local $iIndex = Int(Eval("i" & $i))
If $iIndex >= UBound($aArray, $i) Then Return SetError(3, $i, $NULL)
$sAccess &= '[' & $iIndex & ']'
Next
If @NumParams-1 > $iDims Then ; Still indices left
For $i = $iDims+1 To @NumParams-1
$sAccess &= ", $i" & $i
Next
Local $vResult = Execute("_ArrayGet(" & $sAccess & ")")
If @error Then SetError(@error, @extended+$iDims)
Return $vResult
Else ;
Return Execute($sAccess)
EndIf
EndFunc
</syntaxhighlight>

[[#top | ReturnToContents]]

== _ArraySet ==

{{Snippet Header
|AuthorURL=31965-progandy
|AuthorName=ProgAndy
|Desc=Easy access for nested arrays up to 20 nested dimensions (including multidimensional arrays)
}}

<syntaxhighlight lang = "autoit">
Global $b[2] = ['a', 'b'
Global $a[3][2] = [[0, -1], [$b, "x"], [1, -2]]

Global $c[5] = [11, 22, 33, 44, 55]

_ArraySet($a, $c, 1, 0, 0)

; #FUNCTION# ====================================================================================================================
; Name ..........: _ArraySet
; Description ...: Sets a value from a nested multidimensional array
; Syntax ........: _ArraySet(Byref $aArray, $vValue, $i1[, $i2 = 0[, $i3 = 0[, $i4 = 0[, $i5 = 0[, $i6 = 0[, $i7 = 0[, $i8 = 0[,
; $i9 = 0[, $i10 = 0[, $i11 = 0[, $i12 = 0[, $i13 = 0[, $i14 = 0[, $i15 = 0[, $i16 = 0[, $i17 = 0[,
; $i18 = 0[, $i19 = 0[, $i20 = 0]]]]]]]]]]]]]]]]]]])
; Parameters ....: $aArray - [in/out] An array of unknowns.
; $vValue - value to set at specified index.
; $i1 - first array index.
; $i2 - [optional] second array index.
; $i3 - [optional] third array index.
; $i4 - [optional] fourth array index.
; $i5 - [optional] fifth array index.
; $i6 - [optional] sixth array index.
; $i7 - [optional] seventh array index.
; $i8 - [optional] eighth array index.
; $i9 - [optional] ninth array index.
; $i10 - [optional] 10th array index.
; $i11 - [optional] 11th array index.
; $i12 - [optional] 12th array index.
; $i13 - [optional] 13th array index.
; $i14 - [optional] 14th array index.
; $i15 - [optional] 15th array index.
; $i16 - [optional] 16th array index.
; $i17 - [optional] 17th array index.
; $i18 - [optional] 18th array index.
; $i19 - [optional] 19th array index.
; $i20 - [optional] 20th array index.
; Return values .: Success: True
; Error: False, Sets @error to:
; |1 - Trying to acces non-array as array
; |2 - Not enough dimensions for the last accessed array
; |3 - Index out of bounds for a dimension
; |all: - @extended contains the dimension in error (according to parameter list)
; Author ........: ProgAndy
; Modified ......:
; Remarks .......:
; Related .......:
; Link ..........:
; Example .......: No
; ===============================================================================================================================
Func _ArraySet(ByRef $aArray, Const $vValue, $i1, $i2=0, $i3=0, $i4=0, $i5=0, $i6=0, $i7=0, $i8=0, $i9=0, $i10=0, $i11=0, $i12=0, $i13=0, $i14=0, $i15=0, $i16=0, $i17=0, $i18=0, $i19=0, $i20=0)
; ProgAndy
Local Const $NULL = False

If Not IsArray($aArray) Then Return SetError(1, 1, $NULL)

Local $iDims = UBound($aArray, 0)

If @NumParams-2 < $iDims Then Return SetError(2, @NumParams-1, $NULL)

Local $sAccess = "$aArray"

For $i = 1 To $iDims
Local $iIndex = Int(Eval("i" & $i))
If $iIndex >= UBound($aArray, $i) Then Return SetError(3, $i, $NULL)
$sAccess &= '[' & $iIndex & ']'
Next

If @NumParams-2 > $iDims Then
$sAccess &= ", $vValue"
For $i = $iDims+1 To @NumParams-2
$sAccess &= ", $i" & $i
Next
Local $fSuccess = Execute("_ArraySet(" & $sAccess & ")")
If @error Then SetError(@error, @extended+$iDims)
Return $fSuccess
EndIf

Switch $iDims
Case 1
$aArray[$i1] = $vValue
Case 2
$aArray[$i1][$i2] = $vValue
Case 3
$aArray[$i1][$i2][$i3] = $vValue
Case 4
$aArray[$i1][$i2][$i3][$i4] = $vValue
Case 5
$aArray[$i1][$i2][$i3][$i4][$i5] = $vValue
Case 6
$aArray[$i1][$i2][$i3][$i4][$i5][$i6] = $vValue
Case 7
$aArray[$i1][$i2][$i3][$i4][$i5][$i6][$i7] = $vValue
Case 8
$aArray[$i1][$i2][$i3][$i4][$i5][$i6][$i7][$i8] = $vValue
Case 9
$aArray[$i1][$i2][$i3][$i4][$i5][$i6][$i7][$i8][$i9] = $vValue
Case 10
$aArray[$i1][$i2][$i3][$i4][$i5][$i6][$i7][$i8][$i9][$i10] = $vValue
Case 11
$aArray[$i1][$i2][$i3][$i4][$i5][$i6][$i7][$i8][$i9][$i10][$i11] = $vValue
Case 12
$aArray[$i1][$i2][$i3][$i4][$i5][$i6][$i7][$i8][$i9][$i10][$i11][$i12] = $vValue
Case 13
$aArray[$i1][$i2][$i3][$i4][$i5][$i6][$i7][$i8][$i9][$i10][$i11][$i12][$i13] = $vValue
Case 14
$aArray[$i1][$i2][$i3][$i4][$i5][$i6][$i7][$i8][$i9][$i10][$i11][$i12][$i13][$i14] = $vValue
Case 15
$aArray[$i1][$i2][$i3][$i4][$i5][$i6][$i7][$i8][$i9][$i10][$i11][$i12][$i13][$i14][$i15] = $vValue
Case 16
$aArray[$i1][$i2][$i3][$i4][$i5][$i6][$i7][$i8][$i9][$i10][$i11][$i12][$i13][$i14][$i15][$i16] = $vValue
Case 17
$aArray[$i1][$i2][$i3][$i4][$i5][$i6][$i7][$i8][$i9][$i10][$i11][$i12][$i13][$i14][$i15][$i16][$i17] = $vValue
Case 18
$aArray[$i1][$i2][$i3][$i4][$i5][$i6][$i7][$i8][$i9][$i10][$i11][$i12][$i13][$i14][$i15][$i16][$i17][$i18] = $vValue
Case 19
$aArray[$i1][$i2][$i3][$i4][$i5][$i6][$i7][$i8][$i9][$i10][$i11][$i12][$i13][$i14][$i15][$i16][$i17][$i18][$i19] = $vValue
Case 20
$aArray[$i1][$i2][$i3][$i4][$i5][$i6][$i7][$i8][$i9][$i10][$i11][$i12][$i13][$i14][$i15][$i16][$i17][$i18][$i19][$i20] = $vValue
EndSwitch

Return True
EndFunc
</syntaxhighlight>

[[#top | ReturnToContents]]

== _ArrayLength ==

{{Snippet Header
|AuthorURL=35302-guinness
|AuthorName=guinness
}}

<syntaxhighlight lang = "autoit">
Global $aArray[2][50]
ConsoleWrite(_ArrayLength($aArray, 2) & @CRLF) ;= > 10 - Total items
ConsoleWrite(_ArrayLength($aArray, 1) & @CRLF) ;= > 5 - Columns
ConsoleWrite(_ArrayLength($aArray, 0) & @CRLF) ;= > 2 - Rows

ConsoleWrite(@CRLF)

Global $aArray[2]
ConsoleWrite(_ArrayLength($aArray, 2) & @CRLF) ;= > 2 - Total items
ConsoleWrite(_ArrayLength($aArray, 1) & @CRLF) ;= > 1 - Columns
ConsoleWrite(_ArrayLength($aArray, 0) & @CRLF) ;= > 2 - Rows

Func _ArrayLength($aArray, $iType = 1)
Local $iDim = UBound($aArray, 0)

If $iDim < 0 Or $iDim > 2 Then ; If not a 1D or 2D Array, then return -1 and set @error to non-zero.
Return SetError(1, 0, -1)
EndIf

Switch $iType
Case 2
If $iDim = 2 Then
Return UBound($aArray, 2) * UBound($aArray, 1)
Else
Return UBound($aArray, 1)
EndIf

Case 1
If $iDim = 2 Then
Return UBound($aArray, 2)
Else
Return 1
EndIf

Case Else
Return UBound($aArray, 1)
EndSwitch
EndFunc ;==>_ArrayLength
</syntaxhighlight>

[[#top | ReturnToContents]]

== _ArraySortNum ==

{{Snippet Header
|AuthorURL=4813-smoke-n
|AuthorName=SmOke_N
}}

<syntaxhighlight lang = "autoit">
; ArraySortNum(ByRef $nArray, $Ascending = 0, $Start = 1)
; Sorts arrays based on TRUE Numerical Order, including Decimals

#include <Array.au3>

; Example sort Array created with StringSplit.
Global $avArray = StringSplit("6,8,10,4,2,13,12,129,106.1,106.4", ",")

_ArraySortNum($avArray, 1)
_ArrayDisplay($avArray, "Sorted Desc starting at 1")

Func _ArraySortNum(ByRef $nArray, $Ascending = 0, $Start = 1)
For $i = $Start To UBound($nArray) - 2
Local $SE = $i

If $Ascending = 0 Then
For $x = $i To UBound($nArray) - 1
If Number($nArray[$SE]) < Number($nArray[$x]) Then $SE = $x
Next
Else
For $x = $i To UBound($nArray) - 1
If Number($nArray[$SE]) > Number($nArray[$x]) Then $SE = $x
Next
EndIf

Local $HLD = $nArray[$i]

$nArray[$i] = $nArray[$SE]

$nArray[$SE] = $HLD
Next
EndFunc ;==>_ArraySortNum
</syntaxhighlight>

[[#top | ReturnToContents]]

== _AssocArray ==

{{Snippet Header
|AuthorURL=31149-milesahead
|AuthorName=MilesAhead
}}

<syntaxhighlight lang = "autoit">
; use Scripting.Dictionary object for simple associative arrays
; with string keys. Key comparisons are case insensitive.

Global $myArray
$myArray = _AssocArray()
If @error Then
MsgBox(0x1010,"_AssocArray() Error", "Error Creating Associative Array!")
Exit
EndIf

$myArray("AntiqueWhite") = 0xFAEBD7
$myArray("Black") = 0x000000
$myArray("Blue") = 0x0000FF
$myArray("Brown") = 0xA52A2A
$myArray("CadetBlue") = 0x5F9EA0
$myArray("Chocolate") = 0xD2691E
$myArray("Coral") = 0xFF7F50

MsgBox(0x1040,"","Hex for Chocolate Color is: 0x" & Hex($myArray("Chocolate"),6))
_AssocArrayDestroy($myArray)

Func _AssocArray()
Local $aArray = ObjCreate("Scripting.Dictionary")

If @error Then
Return SetError(1, 0, 0)
EndIf

$aArray.CompareMode = 1

Return $aArray
EndFunc ;==>_AssocArray

Func _AssocArrayDestroy(ByRef $aArray)
If Not IsObj($aArray) Then
Return False
EndIf
$aArray.RemoveAll()
$aArray = 0
Return True
EndFunc ;==>_AssocArrayDestroy
</syntaxhighlight>

[[#top | ReturnToContents]]

== _FuncListToArray ==

{{Snippet Header
|AuthorURL=52-geosoft
|AuthorName=GEOSoft
}}

<syntaxhighlight lang = "autoit">
$aFlist = _FuncListToArray(@ScriptFullPath)
If NOT @Error Then
For $i = 0 To Ubound($aFlist) -1
MsgBox(0, "TEST", $aFlist[$i], 2)
Next
EndIf

Func _FuncListToArray($sStr)
If FileExists($sStr) Then $sStr = FileRead($sStr)
Local $sRegEx = "(?i)(?m:^|\n)\s*Func\s+(\w+)\s*\("
$aRegEx = StringRegExp($sStr, $sRegEx, 3)
If IsArray($aRegEx) Then Return $aRegEx
Return SetError(1)
EndFunc
</syntaxhighlight>

[[#top | ReturnToContents]]

== Identify Duplicate Values In Arrays ==

{{Snippet Header
|AuthorURL=1967-garyfrost
|AuthorName=GaryFrost
}}

<syntaxhighlight lang = "autoit">
; Identify Duplicate Values In Arrays
#include <Array.au3>

Global $a1[3] = [1, 2, 3], $a2[5] = [5, 6, 7, 8, 9], $a3[2] = [3, 5]
Global $a_a[4] = [3, $a1, $a2, $a3]
MsgBox(0, "Dupes?", _SearchForDupes($a_a))

Func _SearchForDupes($a_arrays, $i_ReturnType = 0)
Local $Dupes[1] = [0]

If $a_arrays[0] < 2 Then Return ''

For $i = 1 To $a_a[0] - 1
For $j = $i + 1 To $a_a[0]
_FindDupe($a_a[$i], $a_a[$j], $Dupes)
Next
Next

If $Dupes[0] = 0 Then Return ''

_ArraySort($Dupes)

If Not $i_ReturnType Then
Local $s_return = ''

For $x = 1 To $Dupes[0]
$s_return &= $Dupes[$x] & ','
Next
Return StringTrimRight($s_return, 1)
Else
Return $Dupes
EndIf
EndFunc ;==>_SearchForDupes

Func _FindDupe(ByRef $a_array01, ByRef $a_array02, ByRef $Dupes)
Local $found = False

For $i = 0 To UBound($a_array01) - 1
For $j = 0 To UBound($a_array02) - 1
If $a_array01[$i] = $a_array02[$j] Then
$found = False

For $x = 1 To $Dupes[0]
If $Dupes[$x] = $a_array01[$i] Then
$found = True
ExitLoop
EndIf
Next

If Not $found Then
$Dupes[0] += 1
ReDim $Dupes[$Dupes[0] + 1]
$Dupes[$Dupes[0]] = $a_array01[$i]
EndIf
EndIf
Next
Next
EndFunc ;==>_FindDupe
</syntaxhighlight>

[[#top | ReturnToContents]]

== _Is1DArray ==

{{Snippet Header
|AuthorURL=35302-guinness
|AuthorName=guinness
}}

<syntaxhighlight lang = "autoit">Local $sString = 'String'
Local $a1DArray[2] = [1, 'Row_1']
Local $a2DArray[2][2] = [[1],['Row_1: Col_1', 'Row_1: Col_2']]

ConsoleWrite('Is the variable $sString a 1D Array?: ' & _Is1DArray($sString) & @CRLF)
ConsoleWrite('Is the variable $a1DArray a 1D Array?: ' & _Is1DArray($a1DArray) & @CRLF)
ConsoleWrite('Is the variable $a2DArray a 1D Array?: ' & _Is1DArray($a2DArray) & @CRLF)

; Check if a variable is a 1D Array.
Func _Is1DArray(ByRef Const $aArray)
Return UBound($aArray) And (UBound($aArray, 0) = 1)
EndFunc ;==>_Is1DArray
</syntaxhighlight>

[[#top | ReturnToContents]]

== _Is2DArray ==

{{Snippet Header
|AuthorURL=35302-guinness
|AuthorName=guinness
|Desc=Check if a variable is a 2D Array.
}}

<syntaxhighlight lang = "autoit">Local $sString = 'String'
Local $a1DArray[2] = [1, 'Row_1']
Local $a2DArray[2][2] = [[1],['Row_1: Col_1', 'Row_1: Col_2']]

ConsoleWrite('Is the variable $sString a 1D Array?: ' & _Is2DArray($sString) & @CRLF)
ConsoleWrite('Is the variable $a1DArray a 1D Array?: ' & _Is2DArray($a1DArray) & @CRLF)
ConsoleWrite('Is the variable $a2DArray a 1D Array?: ' & _Is2DArray($a2DArray) & @CRLF)

; Check if a variable is a 2D Array.
Func _Is2DArray(ByRef Const $aArray)
Return UBound($aArray) And (UBound($aArray, 0) = 2)
EndFunc ;==>_Is2DArray
</syntaxhighlight>

[[#top | ReturnToContents]]

== _IsInBounds ==

{{Snippet Header
|AuthorURL=35302-guinness
|AuthorName=guinness
}}

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

Local $aArray[5] = ['Item_1', 'Item_2', 'Item_3', 'Item_4', 'Item_5']

ConsoleWrite(_IsInBounds($aArray, 1) & @CRLF) ; Returns True as the Array has 5 items.
ConsoleWrite(_IsInBounds($aArray, 5) & @CRLF) ; Returns False as the Array has 5 items but starts from the 0th index not 1st.
ConsoleWrite(_IsInBounds($aArray, 0) & @CRLF) ; Returns True.

If _IsInBounds($aArray, 4) Then
MsgBox($MB_SYSTEMMODAL, '', 'Position 4 contains the value: "' & $aArray[4] & '"')
EndIf

Func _IsInBounds(ByRef Const $aArray, $iIndex)
Local $iDim = UBound($aArray, 0)
If $iDim < 0 Or $iDim > 2 Then ; If not a 1D or 2D Array, then return -1 and set @error to non-zero.
Return SetError(1, 0, False)
EndIf
Return $iIndex < UBound($aArray, 1)
EndFunc ;==>_IsInBounds</syntaxhighlight>

[[#top | ReturnToContents]]

== _MultiFileListToArray ==

{{Snippet Header
|AuthorURL=4920-valuater
|AuthorName=Valuater
}}

<syntaxhighlight lang = "autoit">
; Multiple File List to Array

$Files_List = _MultiFileListToArray(@ScriptDir, "*.txt|*.ini")

; for display only
$GUI = GUICreate(" _MultiFileListToArray - DEMO")
$Edit1 = GUICtrlCreateEdit("", 50, 50, 300, 300)
For $x = 1 To UBound($Files_List) - 1
GUICtrlSetData(-1, $Files_List[$x] & @CRLF, 1)
Next
GUISetState()

While GUIGetMsg() <> -3
WEnd
; end display only

Func _MultiFileListToArray($sPath, $sFilter = "*", $iFlag = 0)
Local $hSearch, $sFile, $asFileList[1], $sCount
If Not FileExists($sPath) Then Return SetError(1, 1, "")
If (StringInStr($sFilter, "\")) Or (StringInStr($sFilter, "/")) Or (StringInStr($sFilter, ":")) Or (StringInStr($sFilter, ">")) Or (StringInStr($sFilter, "<")) Or (StringStripWS($sFilter, 8) = "") Then Return SetError(2, 2, "")
$sFilter = (StringSplit($sFilter, "|"))
If Not ($iFlag = 0 Or $iFlag = 1 Or $iFlag = 2) Then Return SetError(3, 3, "")
For $sCount = 1 To $sFilter[0]
$hSearch = FileFindFirstFile($sPath & "\" & $sFilter[$sCount])
If $hSearch = -1 Then
If $sCount = $sFilter[0] Then Return SetError(4, 4, $asFileList)
ContinueLoop
EndIf
While 1
$sFile = FileFindNextFile($hSearch)
If @error Then
SetError(0)
ExitLoop
EndIf
If $iFlag = 1 And StringInStr(FileGetAttrib($sPath & "\" & $sFile), "D") <> 0 Then ContinueLoop
If $iFlag = 2 And StringInStr(FileGetAttrib($sPath & "\" & $sFile), "D") = 0 Then ContinueLoop
ReDim $asFileList[UBound($asFileList) + 1]
$asFileList[0] = $asFileList[0] + 1
$asFileList[UBound($asFileList) - 1] = $sFile
WEnd
FileClose($hSearch)
Next
Return $asFileList
EndFunc ;==>_MultiFileListToArray
</syntaxhighlight>

[[#top | ReturnToContents]]

== Return Min or Max Number From One or Two Arrays ==

{{Snippet Header
|AuthorURL=1967-garyfrost
|AuthorName=GaryFrost
}}

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

Func _MinMaxa($a_nums01, $MaxFlag = 0, $a_nums02 = 0)
If Not IsArray($a_nums01) Then
SetError(1)
Return (0)
EndIf

If @NumParams = 3 Then
If Not IsArray($a_nums02) Then
SetError(3)
Return (0)
EndIf
EndIf

Local $idx

For $idx = 0 To UBound($a_nums01) - 1
If StringIsFloat($a_nums01[$idx]) Or StringIsInt($a_nums01[$idx]) Then
$a_nums01[$idx] = Number($a_nums01[$idx])
Else
SetError(2)
Return (0)
EndIf
Next

_ArraySort($a_nums01, $MaxFlag)

If @NumParams = 3 Then
For $idx = 0 To UBound($a_nums02) - 1
If StringIsFloat($a_nums02[$idx]) Or StringIsInt($a_nums02[$idx]) Then
$a_nums02[$idx] = Number($a_nums02[$idx])
Else
SetError(4)
Return (0)
EndIf
Next

_ArraySort($a_nums02, $MaxFlag)

If $MaxFlag Then
If Number($a_nums01[0]) > Number($a_nums02[0]) Then
Return $a_nums01[0]
Else
Return $a_nums02[0]
EndIf
Else
If Number($a_nums01[0]) < Number($a_nums02[0]) Then
Return $a_nums01[0]
Else
Return $a_nums02[0]
EndIf
EndIf
EndIf

Return $a_nums01[0]
EndFunc ;==>_MinMaxa
</syntaxhighlight>

[[#top | ReturnToContents]]