https://www.autoitscript.com/w/api.php?action=feedcontributions&feedformat=atom&user=SkysnakeAutoIt Wiki - User contributions [en]2026-05-13T15:03:11ZUser contributionsMediaWiki 1.43.6https://www.autoitscript.com/w/index.php?title=Snippets_(_Files_%26_Folders_)&diff=14402Snippets ( Files & Folders )2020-09-20T19:37:51Z<p>Skysnake: /* Windows - Built In ZIP and Unzip (Windows Shell) */</p>
<hr />
<div>__TOC__<br />
[[category:Snippets]]<br />
<br />
{{Snippet Credit Header}}<br />
<br />
== _ConvertFileToUTF16 ==<br />
<br />
{{Snippet Header<br />
| AuthorURL = 35302-guinness<br />
| AuthorName = guinness<br />
}}<br />
<br />
<syntaxhighlight lang="autoit"><br />
_ConvertFileToUTF16(@ScriptDir & "\Example.xml")<br />
<br />
Func _ConvertFileToUTF16($sFilePath)<br />
Local $iEncoding = FileGetEncoding($sFilePath)<br />
Local $hFileOpen = FileOpen($sFilePath, $iEncoding)<br />
If $hFileOpen = -1 Then<br />
Return SetError(1, 0, 0)<br />
EndIf<br />
Local $sData = FileRead($hFileOpen)<br />
FileClose($hFileOpen)<br />
<br />
$hFileOpen = FileOpen($sFilePath, 2 + 32)<br />
If $hFileOpen = -1 Then<br />
Return SetError(2, 0, 0)<br />
EndIf<br />
FileWrite($hFileOpen, $sData)<br />
Return FileClose($hFileOpen)<br />
EndFunc ;==>_ConvertFileToUTF16<br />
</syntaxhighlight><br />
<br />
[[#top | ReturnToContents]]<br />
<br />
== DropFiles ==<br />
<br />
{{Snippet Header<br />
| AuthorURL = 35302-guinness<br />
| AuthorName = guinness<br />
| Desc = Dropping multiple files onto a GUI<br />
}}<br />
<br />
<syntaxhighlight lang="autoit"><br />
; Dropping multiple files onto a GUI<br />
<br />
#include <APIConstants.au3><br />
#include <Array.au3><br />
#include <GUIConstantsEx.au3><br />
#include <WinAPIEx.au3><br />
<br />
Global $__aDropFiles<br />
<br />
Example()<br />
<br />
Func Example()<br />
Local $hGUI = GUICreate('', 500, 500, -1, -1, -1, $WS_EX_ACCEPTFILES)<br />
<br />
; Create a label that is transparent which will accept 'drop' events.<br />
GUICtrlCreateLabel("", 0, 0, 500, 500)<br />
GUICtrlSetBkColor(-1, $GUI_BKCOLOR_TRANSPARENT)<br />
GUICtrlSetResizing(-1, $GUI_DOCKALL)<br />
GUICtrlSetState(-1, $GUI_DROPACCEPTED)<br />
<br />
GUIRegisterMsg($WM_DROPFILES, "WM_DROPFILES")<br />
GUISetState(@SW_SHOW, $hGUI)<br />
<br />
While 1<br />
Switch GUIGetMsg()<br />
Case $GUI_EVENT_CLOSE<br />
ExitLoop<br />
<br />
Case $GUI_EVENT_DROPPED<br />
If $__aDropFiles[0] > 0 Then<br />
_ArrayDisplay($__aDropFiles)<br />
EndIf<br />
<br />
EndSwitch<br />
WEnd<br />
GUIDelete($hGUI)<br />
EndFunc ;==>Example<br />
<br />
Func WM_DROPFILES($hWnd, $iMsg, $iwParam, $ilParam)<br />
#forceref $hWnd, $ilParam<br />
Switch $iMsg<br />
Case $WM_DROPFILES<br />
Local $aReturn = _WinAPI_DragQueryFileEx($iwParam)<br />
If IsArray($aReturn) Then<br />
$__aDropFiles = $aReturn<br />
Else<br />
Local $aError[1] = [0]<br />
$__aDropFiles = $aError<br />
EndIf<br />
EndSwitch<br />
Return $GUI_RUNDEFMSG<br />
EndFunc ;==>WM_DROPFILES<br />
</syntaxhighlight><br />
<br />
[[#top | ReturnToContents]]<br />
<br />
== _ExitCheckTextChange ==<br />
<br />
{{Snippet Header<br />
| AuthorURL = 8007-negativenrg<br />
| AuthorName = NegativeNrG<br />
}}<br />
<br />
<syntaxhighlight lang="autoit"><br />
;Check(when Exit), if Text is not equal to $e_to Then, prompt the user to save or not save.<br />
;_ExitCheckText Change $Edit Handle, $title of messagebox, $message of messagebox, $equal to(default = NULL).<br />
<br />
Func _ExitCheckTextChange($E_hnd,$title,$message,$e_to = '')<br />
Local $buffer, $choice, $filetosave, $handle1<br />
$buffer = GUIctrlread($E_hnd)<br />
If $buffer <> $e_to Then<br />
$choice = Msgbox(4,$title,$message)<br />
If $choice = 6 Then<br />
$filetosave = FileSaveDialog('Choose File',@scriptdir,'(*.au3)')<br />
$handle1 = FileOpen($filetosave,2)<br />
FileWrite($handle1,$buffer)<br />
Exit<br />
Elseif $choice <> 6 Then<br />
Exit<br />
EndIf<br />
Else<br />
Exit<br />
EndIf<br />
EndFunc<br />
</syntaxhighlight><br />
<br />
[[#top | ReturnToContents]]<br />
<br />
== _FileDeleteEx ==<br />
<br />
{{Snippet Header<br />
| AuthorURL = 35302-guinness<br />
| AuthorName = guinness<br />
}}<br />
<br />
<syntaxhighlight lang="autoit"><br />
; Ref: http://msdn.microsoft.com/en-us/library/windows/desktop/aa365240(v=vs.85).aspx<br />
<br />
#include <APIFilesConstants.au3><br />
#include <WinAPIFiles.au3><br />
<br />
ConsoleWrite(_FileDeleteEx("C:\Example.dat") & @CRLF)<br />
<br />
Func _FileDeleteEx($sFilePath)<br />
Return FileDelete($sFilePath) = 1 ? 1 : Int(_WinAPI_MoveFileEx(FileGetShortName($sFilePath), "", $MOVE_FILE_DELAY_UNTIL_REBOOT))<br />
EndFunc ;==>_FileDeleteEx<br />
</syntaxhighlight><br />
<br />
[[#top | ReturnToContents]]<br />
<br />
== _FileCheck ==<br />
<br />
{{Snippet Header<br />
| AuthorURL = 35302-guinness<br />
| AuthorName = guinness<br />
}}<br />
<br />
<syntaxhighlight lang="autoit"><br />
#include <Date.au3><br />
<br />
; Check if the file was modified less than 24 hours ago.<br />
ConsoleWrite( _FileCheck(@ScriptFullPath, 24) & @CRLF)<br />
<br />
Func _FileCheck($sFilePath, $iHours = 24)<br />
Local $aTime<br />
If FileExists($sFilePath) = 0 Then<br />
Return SetError(1, 0, 0)<br />
EndIf<br />
$aTime = FileGetTime($sFilePath, 0, 0)<br />
Return Number(_DateDiff("h", $aTime[0] & "/" & $aTime[1] & "/" & $aTime[2] & " " & $aTime[3] & ":" & $aTime[4] & ":" & $aTime[5], @YEAR & "/" & @MON & "/" & @MDAY & " " & @HOUR & ":" & @MIN & ":" & @SEC) < $iHours)<br />
EndFunc ;==>_FileCheck<br />
</syntaxhighlight><br />
<br />
[[#top | ReturnToContents]]<br />
<br />
== _FileCreateEx ==<br />
<br />
{{Snippet Header<br />
| AuthorURL = 35302-guinness<br />
| AuthorName = guinness<br />
}}<br />
<br />
<syntaxhighlight lang="autoit"><br />
_FileCreateEx(@ScriptDir & '\ExampleFile.txt', 42)<br />
<br />
; Create a blank file with a certain size in bytes.<br />
Func _FileCreateEx($sFilePath, $iBytes = 0)<br />
Return RunWait(@ComSpec & ' /c fsutil file createnew "' & $sFilePath & '" ' & Int($iBytes), @WorkingDir, @SW_HIDE)<br />
EndFunc ;==>_FileCreateEx<br />
</syntaxhighlight><br />
<br />
[[#top | ReturnToContents]]<br />
<br />
== _FileID ==<br />
<br />
{{Snippet Header<br />
| AuthorURL = 35302-guinness<br />
| AuthorName = guinness<br />
}}<br />
<br />
<syntaxhighlight lang="autoit"><br />
#include <Constants.au3><br />
<br />
FileClose(FileOpen(@ScriptDir & '\ExampleFile.txt', 2))<br />
ConsoleWrite(_FileID(@ScriptDir & '\ExampleFile.txt') & @CRLF)<br />
FileDelete(@ScriptDir & '\ExampleFile.txt')<br />
<br />
; Rerieve the file id of a filepath.<br />
Func _FileID($sFilePath)<br />
Local $iPID = Run(@ComSpec & ' /c fsutil file queryfileid "' & $sFilePath & '"', @SystemDir, @SW_HIDE, $STDOUT_CHILD + $STDERR_CHILD), $sReturn = ''<br />
While 1<br />
$sReturn &= StdoutRead($iPID)<br />
If @error Then<br />
ExitLoop<br />
EndIf<br />
WEnd<br />
Return StringStripWS(StringRegExpReplace($sReturn, 'File\sID\sis\s(.*?)', '$1'), 8)<br />
EndFunc ;==>_FileID<br />
</syntaxhighlight><br />
<br />
[[#top | ReturnToContents]]<br />
<br />
== _FileExistsWithQuotes ==<br />
<br />
{{Snippet Header<br />
| AuthorURL = 35302-guinness<br />
| AuthorName = guinness<br />
}}<br />
<br />
<syntaxhighlight lang="autoit"><br />
ConsoleWrite(_FileExistsWithQuotes('"' & @ScriptDir & '"') & @CRLF)<br />
ConsoleWrite(_FileExistsWithQuotes("'" & @ScriptDir & "'") & @CRLF)<br />
ConsoleWrite(_FileExistsWithQuotes(@ScriptDir) & @CRLF)<br />
<br />
; Version: 1.00. AutoIt: V3.3.8.1<br />
; Check a filepath ecists even if the path contains quotation marks.<br />
Func _FileExistsWithQuotes($sFilePath)<br />
Return FileExists(StringRegExpReplace($sFilePath, '^("|'')*([^"'']+)("|'')*$', '\2'))<br />
EndFunc ;==>_FileExistsWithQuotes<br />
</syntaxhighlight><br />
<br />
[[#top | ReturnToContents]]<br />
<br />
== FileLineCount ==<br />
<br />
{{Snippet Header<br />
| AuthorURL = 71214-mkish<br />
| AuthorName = MKISH<br />
| Desc = Checks the number of lines in a file (useful for larger files as well)<br />
}}<br />
<br />
<syntaxhighlight lang="autoit"><br />
; Author - MKISH<br />
<br />
; Checks the number of lines in a file (useful for larger files as well)<br />
<br />
#include <WinAPI.au3><br />
<br />
Local $FILE = "G:\WIN7\sources\boot.wim"<br />
Local $COUNT = 0<br />
Local $start = default<br />
Local $res, $fLen, $err<br />
<br />
While 1<br />
$res = _HexSearch($FILE, StringToBinary("" & @crlf), $start)<br />
$start = $res + 2<br />
$COUNT = $COUNT + 1<br />
If $res = -1 then exitloop<br />
Wend<br />
<br />
msgbox(64, "", "Lines count: " & $COUNT)<br />
<br />
; _HexSearch function (originally written by Zinthose, modified by MKISH)<br />
Func _HexSearch($FilePath, $BinaryValue, $StartOffset = Default)<br />
Local $Buffer, $ptr, $hFile, $Result, $Read, $SearchValue, $Pos, $BufferSize = 2048<br />
If $StartOffset = Default Then $StartOffset = 0<br />
If Not FileExists($FilePath) Then Return SetError(1, @error, 0)<br />
$fLen = FileGetSize($FilePath)<br />
If $StartOffset > $fLen Then Return SetError(2, @error, 0)<br />
If Not IsBinary($BinaryValue) Then Return SetError(3, @error, 0)<br />
If Not IsNumber($StartOffset) Then Return SetError(4, @error, 0)<br />
$SearchValue = BinaryToString($BinaryValue)<br />
$Buffer = DllStructCreate("byte[" & $BufferSize & "]")<br />
$ptr = DllStructGetPtr($Buffer)<br />
$hFile = _WinAPI_CreateFile($FilePath, 2, 2, 1)<br />
If $hFile = 0 Then Return SetError(5, @error, 0)<br />
$Result = _WinAPI_SetFilePointer($hFile, $StartOffset)<br />
$err = @error<br />
If $Result = 0xFFFFFFFF Then<br />
_WinAPI_CloseHandle($hFile)<br />
Return SetError(5, $err, 0)<br />
EndIf<br />
$Pos = $StartOffset<br />
While True<br />
$Read = 0<br />
$Result = _WinAPI_ReadFile($hFile, $ptr, $BufferSize, $Read)<br />
$err = @error<br />
If Not $Result Then<br />
_WinAPI_CloseHandle($hFile)<br />
Return SetError(6, $err, 0)<br />
EndIf<br />
$Result = DllStructGetData($Buffer, 1)<br />
$Result = BinaryToString($Result)<br />
$Result = StringInStr($Result, $SearchValue)<br />
If $Result > 0 Then ExitLoop<br />
If $Read < $BufferSize Then<br />
_WinAPI_CloseHandle($hFile)<br />
Return -1<br />
EndIf<br />
$Pos += $Read<br />
<br />
WEnd<br />
_WinAPI_CloseHandle($hFile)<br />
If Not $Result Then Return SetError(7, @error, 0)<br />
$Result = $Pos + $Result - 1<br />
Return $Result<br />
EndFunc; ==> _HexSearch<br />
</syntaxhighlight><br />
<br />
[[#top | ReturnToContents]]<br />
<br />
== _FileOpenDialog ==<br />
<br />
{{Snippet Header<br />
| AuthorURL = 35302-guinness<br />
| AuthorName = guinness<br />
}}<br />
<br />
<syntaxhighlight lang="autoit"><br />
Local $sFilePath = _FileOpenDialog("", "", "Images (*.jpg;*.bmp)|Videos (*.avi;*.mpg)", Random(1, @DesktopWidth, 1), Random(1, @DesktopHeight, 1), 1 + 4, "")<br />
<br />
ConsoleWrite('File = ' & $sFilePath & ', @error = ' & @error & @CRLF)<br />
<br />
; #FUNCTION# ====================================================================================================================<br />
; Name ..........: _FileOpenDialog<br />
; Description ...: Initiates a Open File Dialog with the option to set the position of the GUI.<br />
; Syntax ........: _FileOpenDialog($sTitle, $sIntitialDirectory, $sFilter[, $iLeft = -1[, $iTop = -1[, $iOptions = 0[,<br />
; $sDefaultName = ""]]]])<br />
; Parameters ....: $sTitle - Title text of the Dialog GUI.<br />
; $sIntitialDirectory - Initial directory selected in the GUI file tree.<br />
; $sFilter - File type single filter such as "All (*.*)" or "Text files (*.txt)".<br />
; $iLeft - [optional] The left side of the dialog box. By default (-1), the window is centered.<br />
; $iTop - [optional] The top of the dialog box. Default (-1) is centered<br />
; $iOptions - [optional] Dialog Options: To use more than one option, add the required values together. See FileOpenDialog. Default is 0.<br />
; $sDefaultName - [optional] Suggested file name for the user to open. Default is blank ("").<br />
; Return values .: Success: Returns the full path of the file(s) chosen. Results for multiple selections are "Directory|file1|file2|..."<br />
; Failure: Sets @error to non-zero.<br />
; Author ........: guinness<br />
; Remarks........: This doesn't change the working directory of the script like FileOpenDialog does.<br />
; Example .......: Yes<br />
; ===============================================================================================================================<br />
Func _FileOpenDialog($sTitle, $sIntitialDirectory, $sFilter, $iLeft = -1, $iTop = -1, $iOptions = 0, $sDefaultName = "")<br />
Local $hGUI = GUICreate('', -1, -1, $iLeft, $iTop), $sWorkingDir = @WorkingDir<br />
Local $sFilePath = FileOpenDialog($sTitle, $sIntitialDirectory, $sFilter, $iOptions, $sDefaultName, $hGUI)<br />
Local $iError = @error<br />
FileChangeDir($sWorkingDir)<br />
Return SetError($iError, GUIDelete($hGUI), $sFilePath)<br />
EndFunc ;==>_FileOpenDialog()<br />
</syntaxhighlight><br />
<br />
[[#top | ReturnToContents]]<br />
<br />
== _FileRename ==<br />
<br />
{{Snippet Header<br />
| AuthorURL = 52374-johnone<br />
| AuthorName = JohnOne<br />
}}<br />
<br />
<syntaxhighlight lang="autoit"><br />
;### Rename a file ###<br />
;$sFile = Full path to file<br />
;$sRename = New Filename<br />
;$iOverWrite = 0 or 1<br />
<br />
;Success returns 1<br />
;failure, returns 0 and sets @error<br />
; 1 if FileMove fails, <br />
; 2 if $sFile does not exist<br />
;@extended<br />
; 0 if the new file does not already exist / existed<br />
; 1 if the new file already exists / existed<br />
<br />
;#### Example ####<br />
$File = @ScriptDir & '\filetorename.txt'<br />
FileWrite($File, 'Test')<br />
_FileRename($File, 'newname.txt')<br />
If @error Then MsgBox(0, "Error", @error)<br />
<br />
Func _FileRename($sFile, $sRename, $iOverWrite = 0)<br />
Local Const $FILENOTEXIST = 2<br />
If Not FileExists($sFile) Then Return SetError($FILENOTEXIST, 0, 0)<br />
Local $_StringLen = StringLen($sFile)<br />
Local $_StringInStr = StringInStr($sFile, "\", 0, -1, $_StringLen)<br />
Local $_Count = $_StringLen - $_StringInStr<br />
Local $_Dir = StringLeft($sFile, $_StringInStr)<br />
Local $_NewFile = $_Dir & $sRename<br />
Local $_NewFileExists = FileExists($_NewFile)<br />
Local $_FileMove = FileMove($sFile, $_NewFile, $iOverWrite)<br />
Return SetError(Not $_FileMove, $_NewFileExists, $_FileMove)<br />
EndFunc ;==>_FileRename<br />
</syntaxhighlight><br />
<br />
== _FileRename Alternative ==<br />
<br />
<syntaxhighlight lang="autoit"><br />
<br />
;FileRename(PathFile, RenameFile)<br />
;JohnOne<br />
<br />
FileRename(@ScriptDir & "\rename.txt", @ScriptDir & "\renamed.txt")<br />
<br />
Func FileRename($FileName, $ReName)<br />
<br />
Local $SHFILEOPSTRUCT, $SourceStruct, $DestStruct<br />
Local Const $FO_RENAME = 0x0004<br />
Local Const $FOF_SILENT = 0x0004<br />
Local Const $FOF_NOCONFIRMATION = 0x0010<br />
Local Const $FOF_NOERRORUI = 0x0400<br />
Local Const $FOF_NOCONFIRMMKDIR = 0x0200<br />
Local Const $NULL = 0<br />
<br />
$SourceStruct = _StringToStruct($FileName)<br />
$DestStruct = _StringToStruct($ReName)<br />
<br />
$SHFILEOPSTRUCT = DllStructCreate("hwnd hWnd;uint wFunc;ptr pFrom;ptr pTo;int fFlags;int fAnyOperationsAborted;ptr hNameMappings;ptr lpszProgressTitle")<br />
<br />
DllStructSetData($SHFILEOPSTRUCT, "hWnd", $NULL)<br />
DllStructSetData($SHFILEOPSTRUCT, "wFunc", $FO_RENAME)<br />
DllStructSetData($SHFILEOPSTRUCT, "pFrom", DllStructGetPtr($SourceStruct))<br />
DllStructSetData($SHFILEOPSTRUCT, "pTo", DllStructGetPtr($DestStruct))<br />
DllStructSetData($SHFILEOPSTRUCT, "fFlags", BitOR($FOF_SILENT, $FOF_NOCONFIRMATION, $FOF_NOERRORUI, $FOF_NOCONFIRMMKDIR))<br />
DllStructSetData($SHFILEOPSTRUCT, "fAnyOperationsAborted", $NULL)<br />
DllStructSetData($SHFILEOPSTRUCT, "hNameMappings", $NULL)<br />
DllStructSetData($SHFILEOPSTRUCT, "lpszProgressTitle", $NULL)<br />
<br />
$acall = DllCall("shell32.dll", "int", "SHFileOperation", "ptr", DllStructGetPtr($SHFILEOPSTRUCT))<br />
If @error Then<br />
Return SetError(@error, @extended, 0)<br />
EndIf<br />
Return 1<br />
EndFunc ;==>FileRename<br />
<br />
Func _StringToStruct($string)<br />
<br />
Local $iLen = StringLen($string)<br />
Local $Struct = DllStructCreate("char[" & String($iLen + 2) & "]")<br />
DllStructSetData($Struct, 1, $string)<br />
DllStructSetData($Struct, 1, 0, $iLen + 1)<br />
DllStructSetData($Struct, 1, 0, $iLen + 2)<br />
<br />
Return $Struct<br />
EndFunc ;==>_StringToStruct<br />
<br />
</syntaxhighlight><br />
<br />
[[#top | ReturnToContents]]<br />
<br />
== _GetFolderDepth ==<br />
<br />
{{Snippet Header<br />
| AuthorURL = 35302-guinness<br />
| AuthorName = guinness<br />
}}<br />
<br />
<syntaxhighlight lang="autoit"><br />
; Autoit 3.3.5.4 and Below<br />
ConsoleWrite(_GetFolderDepth(@ScriptDir & '') & @CRLF)<br />
ConsoleWrite(_GetFolderDepth(@ScriptDir) & @CRLF)<br />
ConsoleWrite(_GetFolderDepth(@ScriptFullPath) & @CRLF)<br />
<br />
; Get the folder depth of a filepath.<br />
Func _GetFolderDepth($sFilePath)<br />
If StringInStr($sFilePath, '.', 2, -1) Then<br />
$sFilePath = StringLeft($sFilePath, StringInStr($sFilePath, "", 2, -1) - 1)<br />
EndIf<br />
Local $aArray = StringSplit(StringRegExpReplace($sFilePath, '[/]+z', ''), '')<br />
Return $aArray[0] - 1<br />
EndFunc ;==>_GetFolderDepth<br />
</syntaxhighlight><br />
<br />
[[#top | ReturnToContents]]<br />
<br />
== _GetFolderDepth ==<br />
<br />
{{Snippet Header<br />
| AuthorURL = 35302-guinness<br />
| AuthorName = guinness<br />
}}<br />
<br />
<syntaxhighlight lang="autoit"><br />
; Autoit 3.3.5.4 and Above<br />
ConsoleWrite(_GetFolderDepth(@ScriptDir & '') & @CRLF)<br />
ConsoleWrite(_GetFolderDepth(@ScriptDir) & @CRLF)<br />
ConsoleWrite(_GetFolderDepth(@ScriptFullPath) & @CRLF)<br />
<br />
; Get the folder depth of a filepath. Works with V3.3.5.4+<br />
Func _GetFolderDepth($sFilePath)<br />
If StringInStr($sFilePath, '.', 2, -1) Then<br />
$sFilePath = StringLeft($sFilePath, StringInStr($sFilePath, "", 2, -1) - 1)<br />
EndIf<br />
Return StringSplit(StringRegExpReplace($sFilePath, '[/]+z', ''), '')[0] - 1<br />
EndFunc ;==>_GetFolderDepth<br />
</syntaxhighlight><br />
<br />
[[#top | ReturnToContents]]<br />
<br />
== _IsDir ==<br />
<br />
{{Snippet Header<br />
| AuthorURL = 35302-guinness<br />
| AuthorName = guinness<br />
}}<br />
<br />
<syntaxhighlight lang="autoit"><br />
ConsoleWrite("IsDir: Using a file - " & IsDir(@ScriptFullPath) & @CRLF) ; Return 0<br />
ConsoleWrite("IsDir: Using a directory - " & IsDir(@ScriptDir) & @CRLF) ; Return 1<br />
<br />
Func IsDir($sFilePath)<br />
Return Int(FileExists($sFilePath) And StringInStr(FileGetAttrib($sFilePath), 'D', Default, 1) > 0)<br />
EndFunc ;==>IsDir<br />
</syntaxhighlight><br />
<br />
[[#top | ReturnToContents]]<br />
<br />
== _IsFile ==<br />
<br />
{{Snippet Header<br />
| AuthorURL = 35302-guinness<br />
| AuthorName = guinness<br />
}}<br />
<br />
<syntaxhighlight lang="autoit"><br />
ConsoleWrite('IsFile: Using a file - ' & IsFile(@ScriptFullPath) & @CRLF) ; Return 1<br />
ConsoleWrite('IsFile: Using a directory - ' & IsFile(@ScriptDir) & @CRLF) ; Return 0<br />
<br />
Func IsFile($sFilePath)<br />
Return Int(FileExists($sFilePath) And StringInStr(FileGetAttrib($sFilePath), 'D', Default, 1) = 0)<br />
EndFunc ;==>IsFilee<br />
</syntaxhighlight><br />
<br />
[[#top | ReturnToContents]]<br />
<br />
== _IsFileDiff ==<br />
<br />
{{Snippet Header<br />
| AuthorURL = 35302-guinness<br />
| AuthorName = guinness<br />
}}<br />
<br />
<syntaxhighlight lang="autoit"><br />
ConsoleWrite(_IsFileDiff(@ScriptFullPath, @ScriptFullPath) & @CRLF) ; This will return False as the files are exactly the same.<br />
ConsoleWrite(_IsFileDiff(@ScriptFullPath, @AutoItExe) & @CRLF) ; This will return True as the files are different.<br />
<br />
; Check if a file is different.<br />
Func _IsFileDiff($sFilePath_1, $sFilePath_2)<br />
Return RunWait(@ComSpec & ' /c FC /B /W "' & $sFilePath_1 & '" "' & $sFilePath_2 & '"', @WorkingDir, @SW_HIDE) > 0<br />
EndFunc ;==>_IsFileDiff<br />
</syntaxhighlight><br />
<br />
[[#top | ReturnToContents]]<br />
<br />
== _IsFileOlder ==<br />
<br />
{{Snippet Header<br />
| AuthorURL = 35302-guinness<br />
| AuthorName = guinness<br />
}}<br />
<br />
<syntaxhighlight lang="autoit"><br />
#include <Date.au3> ; Required for _DateDiff()<br />
#include <MsgBoxConstants.au3><br />
#include <MsgBoxConstants.au3><br />
<br />
; Check if the current script is older than 10 days.<br />
If _IsFileOlder(@ScriptFullPath, 10) Then<br />
MsgBox($MB_SYSTEMMODAL, '', 'File is older than 10 days.')<br />
Else<br />
MsgBox($MB_SYSTEMMODAL, '', 'File isn''t older than 10 days.')<br />
EndIf<br />
<br />
; Is a file older than a certain number of days.<br />
Func _IsFileOlder($sFilePath, $iDays)<br />
Local $aArray = FileGetTime($sFilePath, $FT_CREATED)<br />
Return _DateDiff('D', $aArray[0] & '/' & $aArray[1] & '/' & $aArray[2] & ' ' & $aArray[3] & ':' & $aArray[4] & ':' & $aArray[5], @YEAR & '/' & @MON & '/' & @MDAY & ' ' & @HOUR & ':' & @MIN & ':' & @SEC) >= $iDays<br />
EndFunc ;==>_IsFileOlder<br />
</syntaxhighlight><br />
<br />
[[#top | ReturnToContents]]<br />
<br />
== _IsFileSame ==<br />
<br />
{{Snippet Header<br />
| AuthorURL = 35302-guinness<br />
| AuthorName = guinness<br />
}}<br />
<br />
<syntaxhighlight lang="autoit"><br />
ConsoleWrite(_IsFileSame(@ScriptFullPath, @ScriptFullPath) & @CRLF) ; This will return True as the files are exactly the same.<br />
ConsoleWrite(_IsFileSame(@ScriptFullPath, @AutoItExe) & @CRLF) ; This will return False as the files are different.<br />
<br />
; Check if a file is the same.<br />
Func _IsFileSame($sFilePath_1, $sFilePath_2)<br />
Return RunWait(@ComSpec & ' /c FC /B /W "' & $sFilePath_1 & '" "' & $sFilePath_2 & '"', @WorkingDir, @SW_HIDE) = 0<br />
EndFunc ;==>_IsFileSame<br />
</syntaxhighlight><br />
<br />
[[#top | ReturnToContents]]<br />
<br />
== _IniReadFile ==<br />
<br />
{{Snippet Header<br />
| AuthorURL = 35302-guinness<br />
| AuthorName = guinness<br />
}}<br />
<br />
<syntaxhighlight lang="autoit"><br />
#include <Array.au3><br />
<br />
__INIFileFill(@ScriptDir & '\Example.ini') ; Create an INI file with random data.<br />
<br />
Local $aArray = _IniReadFile(@ScriptDir & '\Example.ini')<br />
FileDelete(@ScriptDir & '\Example.ini')<br />
_ArrayDisplay($aArray)<br />
<br />
Func _IniReadFile($sFilePath)<br />
Local $aReturn[1][3] = [[0, 3]], $aSectionArray, $aSectionNameArray, $iCount = 0<br />
$aSectionNameArray = IniReadSectionNames($sFilePath)<br />
If @error Then<br />
Return SetError(1, 0, $aReturn)<br />
EndIf<br />
For $A = 1 To $aSectionNameArray[0]<br />
$aSectionArray = IniReadSection($sFilePath, $aSectionNameArray[$A])<br />
If @error Then<br />
ContinueLoop<br />
EndIf<br />
For $B = 1 To $aSectionArray[0][0]<br />
$aReturn[0][0] += 1<br />
$iCount += 1<br />
If $aReturn[0][0] <= $iCount + 1 Then<br />
ReDim $aReturn[$aReturn[0][0] * 2][$aReturn[0][1]]<br />
EndIf<br />
$aReturn[$iCount][0] = $aSectionArray[$B][0]<br />
$aReturn[$iCount][1] = $aSectionArray[$B][1]<br />
$aReturn[$iCount][2] = $aSectionNameArray[$A]<br />
Next<br />
Next<br />
ReDim $aReturn[$aReturn[0][0] + 1][$aReturn[0][1]] ; Remove empty entries.<br />
Return $aReturn<br />
EndFunc ;==>_IniReadFile<br />
<br />
Func __INIFileFill($sFilePath)<br />
Local $sData = '', $sHeader = ''<br />
<br />
For $i = 1 To Random(1, 5, 1)<br />
$sHeader = _RandomText(Random(5, 25, 1))<br />
$sData = ""<br />
For $j = 1 To Random(1, 25, 1)<br />
$sData &= _RandomText(Random(5, 25, 1)) & '=' & _RandomText(Random(5, 25, 1)) & @LF<br />
Next<br />
IniWriteSection($sFilePath, $sHeader, $sData)<br />
Next<br />
EndFunc ;==>__FillINIFile<br />
<br />
Func _RandomText($iLength = 10)<br />
Local $sData = '', $sRandom = ''<br />
For $i = 1 To $iLength<br />
$sRandom = Random(55, 116, 1)<br />
$sData &= Chr($sRandom + 6 * ($sRandom > 90) - 7 * ($sRandom < 65))<br />
Next<br />
Return $sData<br />
EndFunc ;==>_RandomText<br />
</syntaxhighlight><br />
<br />
[[#top | ReturnToContents]]<br />
<br />
== _IniReadInit ==<br />
<br />
{{Snippet Header<br />
| AuthorURL = 9370-mlowery<br />
| AuthorName = mlowery<br />
}}<br />
<br />
<syntaxhighlight lang="autoit"><br />
;===============================================================================<br />
; Description: Reads values from INI or creates INI with initial values.<br />
; Intended to ensure all available INI settings are exposed<br />
; and editable.<br />
; Parameters are identical to IniRead()<br />
; Parameter(s): $filename = filename of INI<br />
; $section = section name of INI<br />
; $key = key name in section<br />
; $default = default value (written to INI if not exists)<br />
; Requirement(s): None<br />
; Return Value(s): Returns value from INI (or default if not defined)<br />
; Note(s): Chr(127) used to detect non-existing value since won't normally exist in a text file<br />
;===============================================================================<br />
Func _IniReadInit($filename, $section, $key, $default)<br />
Local $value = IniRead($filename, $section, $key, Chr(127))<br />
If $value = Chr(127) Then<br />
IniWrite($filename, $section, $key, $default)<br />
$value = $default<br />
EndIf<br />
Return $value<br />
EndFunc<br />
</syntaxhighlight><br />
<br />
[[#top | ReturnToContents]]<br />
<br />
== _IsValidFileType ==<br />
<br />
{{Snippet Header<br />
| AuthorURL = 35302-guinness<br />
| AuthorName = guinness<br />
}}<br />
<br />
<syntaxhighlight lang="autoit"><br />
ConsoleWrite(@ScriptFullPath & " >> " & _IsValidFileType(@ScriptFullPath, "bat;cmd;au3") & @CRLF)<br />
ConsoleWrite(@AutoItExe & " >> " & _IsValidFileType(@AutoItExe, "bat;cmd;au3") & @CRLF)<br />
<br />
; Check if a filepath matches an extension filetype. Based on the idea by guinness - http://www.autoitscript.com/forum/topic/123674-isvalidfiletype/<br />
Func _IsValidFileType($sFilePath, $sList = "bat;cmd;exe") ; By AZJIO - http://www.autoitscript.com/forum/topic/...filetype/page__view__findpost_<br />
Local $iDot = StringInStr($sFilePath, ".", 0, -1)<br />
Return $iDot And StringInStr(';' & $sList & ';', ';' & StringTrimLeft($sFilePath, $iDot) & ';') > 0<br />
EndFunc ;==>_IsValidFileType<br />
</syntaxhighlight><br />
<br />
<syntaxhighlight lang="autoit"><br />
; Example 2<br />
<br />
#include <WinAPIEx.au3><br />
<br />
ConsoleWrite(@ScriptFullPath & " >> " & _IsValidFileType(@ScriptFullPath, "bat;cmd;au3") & @CRLF)<br />
ConsoleWrite(@AutoItExe & " >> " & _IsValidFileType(@AutoItExe, "bat;cmd;au3") & @CRLF)<br />
<br />
; Check if a filepath matches an extension filetype. Based on the idea by guinness - http://www.autoitscript.com/forum/topic/123674-isvalidfiletype/<br />
Func _IsValidFileType($sFilePath, $sList = "bat;cmd;exe", $iOpFast = 1) ; By Yashied.<br />
If StringStripWS($sList, 8) = "" Then<br />
$sList = "*"<br />
EndIf<br />
Return _WinAPI_PathMatchSpec($sFilePath, StringReplace(';' & $sList, ';', ';*.', 0, $iOpFast * 2))<br />
EndFunc ;==>_IsValidFileType<br />
</syntaxhighlight><br />
<br />
[[#top | ReturnToContents]]<br />
<br />
== File Open/Save/Folder Dialog Box ==<br />
<br />
{{Snippet Header<br />
| AuthorURL = 2709-mhz<br />
| AuthorName = MHz<br />
| AuthorURL2 = 4997-odklizec<br />
| AuthorName2 = odklizec<br />
| AuthorURL3 = 6756-danny35d<br />
| AuthorName3 = Danny35d<br />
}}<br />
<br />
<syntaxhighlight lang="autoit"><br />
; Center - File Open/Save/Folder Dialog Box<br />
; Author - odklizec, MHz, Danny35d<br />
<br />
If StringInStr($cmdlineraw, '/MoveWin') Then<br />
Local $size, $PosX, $PosY<br />
$cmdlineraw = StringSplit(StringMid($cmdlineraw, StringInStr($cmdlineraw, '/MoveWin')), ':')<br />
While 1<br />
Select<br />
Case WinExists($cmdlineraw[2])<br />
$size=WinGetPos ($cmdlineraw[2])<br />
$PosX=@DesktopWidth/2 - $size[2]/2<br />
$PosY=@DesktopHeight/2 - $size[3]/2<br />
WinMove($cmdlineraw[2], "", $PosX, $PosY)<br />
WinActivate($cmdlineraw[2])<br />
ExitLoop<br />
EndSelect<br />
Sleep(50)<br />
WEnd<br />
Exit<br />
EndIf<br />
Global $PID, $Read_File, $Save_File<br />
$PID = _FindBrowseWin('Open file Dialog Box')<br />
$Read_File = FileOpenDialog ( "Open file Dialog Box", @ScriptDir & "\", "AutoIt Files (*.au3)",3,@ScriptFullPath)<br />
ProcessClose($PID)<br />
$PID = _FindBrowseWin('Save file Dialog Box')<br />
$Save_File = FileSaveDialog( "Save file Dialog Box", @ScriptDir, "Scripts (*.aut;*.au3)", 3)<br />
ProcessClose($PID)<br />
$PID = _FindBrowseWin('Browse for Folder')<br />
FileSelectFolder("Choose a folder with plugins..", "","4","c:\")<br />
ProcessClose($PID)<br />
<br />
Func _FindBrowseWin($sTitle)<br />
If @Compiled Then<br />
Return(Run(@ScriptFullPath & ' /MoveWin:' & $sTitle))<br />
Else<br />
Return(Run(@AutoItExe & ' "' & @ScriptFullPath & '" /MoveWin:' & $sTitle))<br />
EndIf<br />
EndFunc<br />
</syntaxhighlight><br />
<br />
[[#top | ReturnToContents]]<br />
<br />
== _MoveFileOnReboot ==<br />
<br />
{{Snippet Header<br />
| AuthorURL = 44525-jscript<br />
| AuthorName = JScript<br />
}}<br />
<br />
<syntaxhighlight lang="autoit"><br />
;Author: JScript - Snippet Version No. = 1.0<br />
;Snippet was Created Using AutoIt Version = 3.3.2.0, Creation Date = 21/03/12.<br />
<br />
; Function to Move or Delete a file on next reboot!<br />
Func _MoveFileOnReboot($sSourcePath, $sDestPath = ""); If $sDestPath = "" the file is deleted instead of moved.<br />
Local $iRet<br />
<br />
; PendingFileRenameOperations (HKLM\SYSTEM\CurrentControlSet\Control\Session Manager)<br />
If $DestPath = "" Then<br />
$iRet = DllCall("kernel32.dll", "int", "MoveFileExA", "str", $sSourcePath, "int", 0, "dword", 4)<br />
Else<br />
$iRet = DllCall("kernel32.dll", "int", "MoveFileExA", "str", $sSourcePath, "str", $sDestPath, "dword", 4)<br />
EndIf<br />
<br />
Return $iRet<br />
EndFunc ;==>_MoveFileOnReboot<br />
</syntaxhighlight><br />
<br />
[[#top | ReturnToContents]]<br />
<br />
== _MultipleFileOpenDialog ==<br />
<br />
{{Snippet Header<br />
| AuthorURL =<br />
| AuthorName = /dev/null<br />
}}<br />
<br />
<syntaxhighlight lang="autoit"><br />
Local $message = "Hold down Ctrl or Shift to choose multiple files."<br />
<br />
Local $filename = _MultipleFileOpenDialog($message,300,300)<br />
<br />
Local $var = FileOpenDialog($message, @WindowsDir & "\", "Images (*.jpg;*.bmp)", 1 + 4 )<br />
<br />
If @error Then<br />
MsgBox(4096,"","No File(s) chosen")<br />
Else<br />
$var = StringReplace($var, "|", @CRLF)<br />
MsgBox(4096,"","You chose " & $var)<br />
EndIf<br />
<br />
FileDelete($filename)<br />
func _MultipleFileOpenDialog($title,$posx,$posy)<br />
Local $temp = EnvGet("temp")<br />
Local $filename = $temp & "\move_file_open_dialog.au3"<br />
<br />
Local $script = 'Global $title = "' & $title & '"' & @CRLF<br />
$script &= 'Global $pos_x = ' & $posx & @CRLF<br />
$script &= 'Global $pos_y = ' & $posy & @CRLF<br />
$script &= 'AdlibRegister("_Move",10)' & @CRLF<br />
$script &= 'while 1' & @CRLF<br />
$script &= ' sleep(1000)' & @CRLF<br />
$script &= 'wend' & @CRLF<br />
$script &= 'Func _Move()' & @CRLF<br />
$script &= ' if (WinActive($title)) Then' & @CRLF<br />
$script &= ' WinMove($title,"",$pos_x,$pos_y)' & @CRLF<br />
$script &= ' Exit' & @CRLF<br />
$script &= ' EndIf' & @CRLF<br />
$script &= 'EndFunc' & @CRLF<br />
<br />
FileWrite($filename,$script)<br />
;MsgBox(0,"",$script & @CRLF & $filename)<br />
Run(@AutoItExe & " /AutoIt3ExecuteScript " & $filename)<br />
sleep(250)<br />
Return $filename<br />
EndFunc ;==>_MultipleFileOpenDialog()<br />
</syntaxhighlight><br />
<br />
[[#top | ReturnToContents]]<br />
<br />
== _OpenFolder ==<br />
<br />
{{Snippet Header<br />
| AuthorURL = 35302-guinness<br />
| AuthorName = guinness<br />
}}<br />
<br />
<syntaxhighlight lang="autoit"><br />
#cs<br />
These have been declared in Global scope as you may wish to use them elsewhere in your script.<br />
#ce<br />
Global $ALTSTARTUP = 0x1d<br />
Global $APPDATA = 0x1a<br />
Global $BITBUCKET = 0x0a<br />
Global $COMMONALTSTARTUP = 0x1e<br />
Global $COMMONAPPDATA = 0x23<br />
Global $COMMONDESKTOPDIR = 0x19<br />
Global $COMMONFAVORITES = 0x1f<br />
Global $COMMONPROGRAMS = 0x17<br />
Global $COMMONSTARTMENU = 0x16<br />
Global $COMMONSTARTUP = 0x18<br />
Global $CONTROLS = 0x03<br />
Global $COOKIES = 0x21<br />
Global $DESKTOP = 0x00<br />
Global $DESKTOPDIRECTORY = 0x10<br />
Global $DRIVES = 0x11<br />
Global $FAVORITES = 0x06<br />
Global $FONTS = 0x14<br />
Global $HISTORY = 0x22<br />
Global $INTERNETCACHE = 0x20<br />
Global $LOCALAPPDATA = 0x1c<br />
Global $MYPICTURES = 0x27<br />
Global $NETHOOD = 0x13<br />
Global $NETWORK = 0x12<br />
Global $PERSONAL = 0x05<br />
Global $PRINTERS = 0x04<br />
Global $PRINTHOOD = 0x1b<br />
Global $PROFILE = 0x28<br />
Global $PROGRAMFILES = 0x26<br />
Global $PROGRAMFILESx86 = 0x30<br />
Global $PROGRAMS = 0x02<br />
Global $RECENT = 0x08<br />
Global $SENDTO = 0x09<br />
Global $STARTMENU = 0x0b<br />
Global $STARTUP = 0x07<br />
Global $SYSTEM = 0x25<br />
Global $SYSTEMx86 = 0x29<br />
Global $TEMPLATES = 0x15<br />
Global $WINDOWS = 0x24<br />
<br />
ConsoleWrite(_OpenFolder(@ScriptDir) & @CRLF)<br />
ConsoleWrite(_OpenFolder($PRINTERS) & @CRLF)<br />
<br />
; Open a folder or special folder variable, similar to using ShellExecute.<br />
Func _OpenFolder($sFolderPath)<br />
Local $oShell = ObjCreate('shell.application')<br />
If @error Then<br />
Return SetError(1, 0, 0)<br />
EndIf<br />
$oShell.Open($sFolderPath)<br />
Return 1<br />
EndFunc ;==>_OpenFolder<br />
</syntaxhighlight><br />
<br />
[[#top | ReturnToContents]]<br />
<br />
== _PathAppendToFilename ==<br />
<br />
{{Snippet Header<br />
| AuthorURL = 31965-progandy<br />
| AuthorName = ProgAndy<br />
}}<br />
<br />
<syntaxhighlight lang="autoit"><br />
$sOrg = "C:\Some.Folder\some.file.ext"<br />
$sAdd = "_backup"<br />
<br />
$sNew = _PathAppendToFilename($sOrg, $sAdd)<br />
<br />
$sStripped = _PathStripRightFromFilename($sNew, $sAdd)<br />
<br />
MsgBox(0, "", $sOrg & @CRLF & $sAdd & @CRLF & $sNew & @CRLF & $sStripped)<br />
<br />
Func _PathAppendToFilename($sName, $sAppend)<br />
; Author: ProgAndy<br />
If StringRegExp($sAppend, '[\/\\:\?"<>\|\*]') Then Return SetError(1, 0, $sName)<br />
Return StringRegExpReplace($sName, "(\.[^\\/\.]+)$", $sAppend & "\1", 1)<br />
EndFunc<br />
</syntaxhighlight><br />
<br />
[[#top | ReturnToContents]]<br />
<br />
== _PathStripRightFromFilename ==<br />
<br />
{{Snippet Header<br />
| AuthorURL = 31965-progandy<br />
| AuthorName = ProgAndy<br />
}}<br />
<br />
<syntaxhighlight lang="autoit"><br />
Func _PathStripRightFromFilename($sName, $sStrip)<br />
; Author: ProgAndy<br />
If StringRegExp($sStrip, '[\/\\:\?"<>\|\*]') Then Return SetError(1, 0, $sName)<br />
Return StringRegExpReplace($sName, "\Q" & $sStrip & "\E(\.[^\\/\.]+)$", "\1", 1)<br />
EndFunc<br />
</syntaxhighlight><br />
<br />
[[#top | ReturnToContents]]<br />
<br />
== _SelfDelete ==<br />
<br />
{{Snippet Header<br />
| AuthorURL = 2709-mhz<br />
| AuthorName = MHz<br />
}}<br />
<br />
<syntaxhighlight lang="autoit"><br />
; This also removes the directory which the file is in<br />
; Author MHz with the directory delete addition by The Kandie Man<br />
Func _SelfDelete($iDelay = 0)<br />
Local $sCmdFile<br />
FileDelete(@TempDir & "\scratch.bat")<br />
$sCmdFile = 'ping -n ' & $iDelay & '127.0.0.1 > nul' & @CRLF _<br />
& ':loop' & @CRLF _<br />
& 'del "' & @ScriptFullPath & '"' & @CRLF _<br />
& 'if exist "' & @ScriptFullPath & '" goto loop' & @CRLF _<br />
& ':loop2' & @CRLF _<br />
& 'rmdir /q "' & $dirToDelete & '"' & @CRLF _<br />
& 'if exist "' & $dirToDelete & '" goto loop2' & @CRLF _<br />
& 'del ' & @TempDir & '\scratch.bat'<br />
FileWrite(@TempDir & "\scratch.bat", $sCmdFile)<br />
Run(@TempDir & "\scratch.bat", @TempDir, @SW_HIDE)<br />
EndFunc<br />
</syntaxhighlight><br />
<br />
[[#top | ReturnToContents]]<br />
<br />
== _ShellExecuteFileSelectFolder ==<br />
<br />
{{Snippet Header<br />
| AuthorURL = 35302-guinness<br />
| AuthorName = guinness<br />
}}<br />
<br />
<syntaxhighlight lang="autoit"><br />
ConsoleWrite(_ShellExecuteFileSelectFolder('Select a Folder', @HomeDrive) & @CRLF)<br />
<br />
; Shell Execute a selected folder.<br />
Func _ShellExecuteFileSelectFolder($sText, $sRoot, $iFlag = 0, $sInitialDir = '', $hWnd = '')<br />
Local $sFolder = FileSelectFolder($sText, $sRoot, $iFlag, $sInitialDir, $hWnd)<br />
If @error Then<br />
Return SetError(@error, @extended, '')<br />
EndIf<br />
ShellExecute($sFolder)<br />
Return $sFolder<br />
EndFunc ;==>_ShellExecuteFileSelectFolder<br />
</syntaxhighlight><br />
<br />
[[#top | ReturnToContents]]<br />
<br />
== _SuiCide ==<br />
<br />
{{Snippet Header<br />
| AuthorURL = 28010-larrydalooza<br />
| AuthorName = LarryDalooza<br />
}}<br />
<br />
<syntaxhighlight lang="autoit"><br />
; IMPORTANT MAKE A COPY OF SCRIPT BEFORE DELETION<br />
; Deletes the running script<br />
<br />
Func SuiCide()<br />
Local $sFilePath = @TempDir & '\SuiCide.bat'<br />
FileDelete($sFilePath)<br />
FileWrite($sFilePath, 'loop:' & @CRLF & 'del "' & @ScriptFullPath & '"' & @CRLF & _<br />
'ping -n 1 -w 250 zxywqxz_q' & @CRLF & 'if exist "' & @ScriptFullPath & _<br />
'" goto loop' & @CRLF & 'del SuiCide.bat' & @CRLF)<br />
Exit Run($sFilePath, @TempDir, @SW_HIDE)<br />
EndFunc ;==>SuiCide<br />
</syntaxhighlight><br />
<br />
[[#top | ReturnToContents]]<br />
<br />
== _UniqueFilename ==<br />
<br />
{{Snippet Header<br />
| AuthorURL = 35302-guinness<br />
| AuthorName = guinness<br />
}}<br />
<br />
<syntaxhighlight lang="autoit"><br />
<br />
ConsoleWrite(_UniqueFilename(@ScriptDir, '.au3') & @CRLF)<br />
<br />
Func _UniqueFilename($sFilePath, $sExtension)<br />
Local $iRandom = 0, $sUnqiueFileName = ''<br />
<br />
$sExtension = '.' & StringRegExpReplace($sExtension, '\A[\.]+', '')<br />
$sFilePath = StringRegExpReplace($sFilePath, '[\\/]+\z', '') & '\'<br />
While 1<br />
$iRandom = Random(55, 116, 1)<br />
$sUnqiueFileName &= Chr($iRandom + 6 * ($iRandom > 90) - 7 * ($iRandom < 65))<br />
If FileExists($sFilePath & $sUnqiueFileName & $sExtension) = 0 And StringLen($sUnqiueFileName) > 7 Then<br />
ExitLoop<br />
EndIf<br />
WEnd<br />
Return $sFilePath & $sUnqiueFileName & $sExtension<br />
EndFunc ;==>_UniqueFilename<br />
</syntaxhighlight><br />
<br />
[[#top | ReturnToContents]]<br />
<br />
== Windows - Copy With Progress ==<br />
<br />
{{Snippet Header<br />
| AuthorURL = 19-jos<br />
| AuthorName = Jos<br />
}}<br />
<br />
<syntaxhighlight lang="autoit"><br />
; Windows - Copy With Progress<br />
<br />
;~ 4 Do not display a progress dialog box.<br />
;~ 8 Give the file being operated on a new name in a move, copy, or rename operation if a file with the target name already exists.<br />
;~ 16 Respond with "Yes to All" for any dialog box that is displayed.<br />
;~ 64 Preserve undo information, if possible.<br />
;~ 128 Perform the operation on files only if a wildcard file name (*.*) is specified.<br />
;~ 256 Display a progress dialog box but do not show the file names.<br />
;~ 512 Do not confirm the creation of a new directory if the operation requires one to be created.<br />
;~ 1024 Do not display a user interface if an error occurs.<br />
;~ 2048 Version 4.71. Do not copy the security attributes of the file.<br />
;~ 4096 Only operate in the local directory. Don't operate recursively into subdirectories.<br />
;~ 8192 Version 5.0. Do not copy connected files as a group. Only copy the specified files.<br />
<br />
_FileCopy("C:\Installed Apps\Patches\WindowsXP-KB835935-SP2-ENU.exe","C:\temp")<br />
<br />
; to copy a directory the destination directory must exist<br />
<br />
Func _FileCopy($fromFile,$tofile)<br />
Local $FOF_RESPOND_YES = 16<br />
Local $FOF_SIMPLEPROGRESS = 256<br />
$winShell = ObjCreate("shell.application")<br />
$winShell.namespace($tofile).CopyHere($fromFile,$FOF_RESPOND_YES)<br />
EndFunc<br />
</syntaxhighlight><br />
<br />
<br />
<br />
== Windows - Built In ZIP and Unzip (Windows Shell) ==<br />
<br />
{{Snippet Header<br />
| AuthorName = Nine<br />
}}<br />
<br />
<syntaxhighlight lang="autoit"><br />
#include <Constants.au3><br />
#include <String.au3><br />
<br />
Opt("MustDeclareVars", 1)<br />
<br />
Const $sZipFile = @ScriptDir & "\Test.zip"<br />
Const $sFolder = @ScriptDir & "\Temp"<br />
Const $sZipNew = @ScriptDir & "\Test2.zip"<br />
<br />
DirRemove ($sFolder, $DIR_REMOVE)<br />
UnZip($sZipFile, $sFolder)<br />
If @error Then Exit MsgBox ($MB_SYSTEMMODAL,"","Error unzipping files : " & @error)<br />
FileDelete ($sZipNew)<br />
Zip ($sZipNew, $sFolder)<br />
If @error Then Exit MsgBox ($MB_SYSTEMMODAL,"","Error zipping files : " & @error)<br />
<br />
Func UnZip($sZipFile, $sDestFolder)<br />
If Not FileExists($sZipFile) Then Return SetError (1) ; source file does not exists<br />
If Not FileExists($sDestFolder) Then<br />
If Not DirCreate($sDestFolder) Then Return SetError (2) ; unable to create destination<br />
Else<br />
If Not StringInStr(FileGetAttrib($sDestFolder), "D") Then Return SetError (3) ; destination not folder<br />
EndIf<br />
Local $oShell = ObjCreate("shell.application")<br />
Local $oZip = $oShell.NameSpace($sZipFile)<br />
Local $iZipFileCount = $oZip.items.Count<br />
If Not $iZipFileCount Then Return SetError (4) ; zip file empty<br />
For $oFile In $oZip.items<br />
$oShell.NameSpace($sDestFolder).copyhere($ofile)<br />
Next<br />
EndFunc ;==>UnZip<br />
<br />
Func Zip ($sZipFile, $sSourceFolder)<br />
If FileExists($sZipFile) Then Return SetError (1) ; destination file already exists<br />
If Not FileExists($sSourceFolder) Then Return SetError (2) ; source does not exist<br />
Local $hFile = FileOpen ($sZipFile, $FO_CREATEPATH+$FO_OVERWRITE+$FO_BINARY)<br />
Local Const $sString = Chr(80) & Chr(75) & Chr(5) & Chr(6) & _StringRepeat (Chr(0), 18) ; create ZIP file signature<br />
FileWrite ($hFile, $sString)<br />
FileClose($hFile)<br />
Local $oShell = ObjCreate("shell.application")<br />
If Not $oShell.NameSpace ($sSourceFolder).items.count Then Return SetError (3) ; folder empty<br />
Local $iFiles = 0<br />
For $oFile In $oShell.NameSpace($sSourceFolder).items<br />
$oShell.NameSpace($sZipFile).copyhere($oFile)<br />
Do<br />
Sleep (100) ; let the file being copied to ZIP<br />
Until $oShell.NameSpace($sZipFile).items.count > $iFiles<br />
$iFiles = $oShell.NameSpace($sZipFile).items.count<br />
Next<br />
EndFunc<br />
</syntaxhighlight><br />
<br />
<br />
[[#top | ReturnToContents]]</div>Skysnakehttps://www.autoitscript.com/w/index.php?title=Snippets_(_Files_%26_Folders_)&diff=14391Snippets ( Files & Folders )2020-09-01T12:14:00Z<p>Skysnake: /* Windows - Built In Unzip (Windows Shell) */</p>
<hr />
<div>__TOC__<br />
[[category:Snippets]]<br />
<br />
{{Snippet Credit Header}}<br />
<br />
== _ConvertFileToUTF16 ==<br />
<br />
{{Snippet Header<br />
| AuthorURL = 35302-guinness<br />
| AuthorName = guinness<br />
}}<br />
<br />
<syntaxhighlight lang="autoit"><br />
_ConvertFileToUTF16(@ScriptDir & "\Example.xml")<br />
<br />
Func _ConvertFileToUTF16($sFilePath)<br />
Local $iEncoding = FileGetEncoding($sFilePath)<br />
Local $hFileOpen = FileOpen($sFilePath, $iEncoding)<br />
If $hFileOpen = -1 Then<br />
Return SetError(1, 0, 0)<br />
EndIf<br />
Local $sData = FileRead($hFileOpen)<br />
FileClose($hFileOpen)<br />
<br />
$hFileOpen = FileOpen($sFilePath, 2 + 32)<br />
If $hFileOpen = -1 Then<br />
Return SetError(2, 0, 0)<br />
EndIf<br />
FileWrite($hFileOpen, $sData)<br />
Return FileClose($hFileOpen)<br />
EndFunc ;==>_ConvertFileToUTF16<br />
</syntaxhighlight><br />
<br />
[[#top | ReturnToContents]]<br />
<br />
== DropFiles ==<br />
<br />
{{Snippet Header<br />
| AuthorURL = 35302-guinness<br />
| AuthorName = guinness<br />
| Desc = Dropping multiple files onto a GUI<br />
}}<br />
<br />
<syntaxhighlight lang="autoit"><br />
; Dropping multiple files onto a GUI<br />
<br />
#include <APIConstants.au3><br />
#include <Array.au3><br />
#include <GUIConstantsEx.au3><br />
#include <WinAPIEx.au3><br />
<br />
Global $__aDropFiles<br />
<br />
Example()<br />
<br />
Func Example()<br />
Local $hGUI = GUICreate('', 500, 500, -1, -1, -1, $WS_EX_ACCEPTFILES)<br />
<br />
; Create a label that is transparent which will accept 'drop' events.<br />
GUICtrlCreateLabel("", 0, 0, 500, 500)<br />
GUICtrlSetBkColor(-1, $GUI_BKCOLOR_TRANSPARENT)<br />
GUICtrlSetResizing(-1, $GUI_DOCKALL)<br />
GUICtrlSetState(-1, $GUI_DROPACCEPTED)<br />
<br />
GUIRegisterMsg($WM_DROPFILES, "WM_DROPFILES")<br />
GUISetState(@SW_SHOW, $hGUI)<br />
<br />
While 1<br />
Switch GUIGetMsg()<br />
Case $GUI_EVENT_CLOSE<br />
ExitLoop<br />
<br />
Case $GUI_EVENT_DROPPED<br />
If $__aDropFiles[0] > 0 Then<br />
_ArrayDisplay($__aDropFiles)<br />
EndIf<br />
<br />
EndSwitch<br />
WEnd<br />
GUIDelete($hGUI)<br />
EndFunc ;==>Example<br />
<br />
Func WM_DROPFILES($hWnd, $iMsg, $iwParam, $ilParam)<br />
#forceref $hWnd, $ilParam<br />
Switch $iMsg<br />
Case $WM_DROPFILES<br />
Local $aReturn = _WinAPI_DragQueryFileEx($iwParam)<br />
If IsArray($aReturn) Then<br />
$__aDropFiles = $aReturn<br />
Else<br />
Local $aError[1] = [0]<br />
$__aDropFiles = $aError<br />
EndIf<br />
EndSwitch<br />
Return $GUI_RUNDEFMSG<br />
EndFunc ;==>WM_DROPFILES<br />
</syntaxhighlight><br />
<br />
[[#top | ReturnToContents]]<br />
<br />
== _ExitCheckTextChange ==<br />
<br />
{{Snippet Header<br />
| AuthorURL = 8007-negativenrg<br />
| AuthorName = NegativeNrG<br />
}}<br />
<br />
<syntaxhighlight lang="autoit"><br />
;Check(when Exit), if Text is not equal to $e_to Then, prompt the user to save or not save.<br />
;_ExitCheckText Change $Edit Handle, $title of messagebox, $message of messagebox, $equal to(default = NULL).<br />
<br />
Func _ExitCheckTextChange($E_hnd,$title,$message,$e_to = '')<br />
Local $buffer, $choice, $filetosave, $handle1<br />
$buffer = GUIctrlread($E_hnd)<br />
If $buffer <> $e_to Then<br />
$choice = Msgbox(4,$title,$message)<br />
If $choice = 6 Then<br />
$filetosave = FileSaveDialog('Choose File',@scriptdir,'(*.au3)')<br />
$handle1 = FileOpen($filetosave,2)<br />
FileWrite($handle1,$buffer)<br />
Exit<br />
Elseif $choice <> 6 Then<br />
Exit<br />
EndIf<br />
Else<br />
Exit<br />
EndIf<br />
EndFunc<br />
</syntaxhighlight><br />
<br />
[[#top | ReturnToContents]]<br />
<br />
== _FileDeleteEx ==<br />
<br />
{{Snippet Header<br />
| AuthorURL = 35302-guinness<br />
| AuthorName = guinness<br />
}}<br />
<br />
<syntaxhighlight lang="autoit"><br />
; Ref: http://msdn.microsoft.com/en-us/library/windows/desktop/aa365240(v=vs.85).aspx<br />
<br />
#include <APIFilesConstants.au3><br />
#include <WinAPIFiles.au3><br />
<br />
ConsoleWrite(_FileDeleteEx("C:\Example.dat") & @CRLF)<br />
<br />
Func _FileDeleteEx($sFilePath)<br />
Return FileDelete($sFilePath) = 1 ? 1 : Int(_WinAPI_MoveFileEx(FileGetShortName($sFilePath), "", $MOVE_FILE_DELAY_UNTIL_REBOOT))<br />
EndFunc ;==>_FileDeleteEx<br />
</syntaxhighlight><br />
<br />
[[#top | ReturnToContents]]<br />
<br />
== _FileCheck ==<br />
<br />
{{Snippet Header<br />
| AuthorURL = 35302-guinness<br />
| AuthorName = guinness<br />
}}<br />
<br />
<syntaxhighlight lang="autoit"><br />
#include <Date.au3><br />
<br />
; Check if the file was modified less than 24 hours ago.<br />
ConsoleWrite( _FileCheck(@ScriptFullPath, 24) & @CRLF)<br />
<br />
Func _FileCheck($sFilePath, $iHours = 24)<br />
Local $aTime<br />
If FileExists($sFilePath) = 0 Then<br />
Return SetError(1, 0, 0)<br />
EndIf<br />
$aTime = FileGetTime($sFilePath, 0, 0)<br />
Return Number(_DateDiff("h", $aTime[0] & "/" & $aTime[1] & "/" & $aTime[2] & " " & $aTime[3] & ":" & $aTime[4] & ":" & $aTime[5], @YEAR & "/" & @MON & "/" & @MDAY & " " & @HOUR & ":" & @MIN & ":" & @SEC) < $iHours)<br />
EndFunc ;==>_FileCheck<br />
</syntaxhighlight><br />
<br />
[[#top | ReturnToContents]]<br />
<br />
== _FileCreateEx ==<br />
<br />
{{Snippet Header<br />
| AuthorURL = 35302-guinness<br />
| AuthorName = guinness<br />
}}<br />
<br />
<syntaxhighlight lang="autoit"><br />
_FileCreateEx(@ScriptDir & '\ExampleFile.txt', 42)<br />
<br />
; Create a blank file with a certain size in bytes.<br />
Func _FileCreateEx($sFilePath, $iBytes = 0)<br />
Return RunWait(@ComSpec & ' /c fsutil file createnew "' & $sFilePath & '" ' & Int($iBytes), @WorkingDir, @SW_HIDE)<br />
EndFunc ;==>_FileCreateEx<br />
</syntaxhighlight><br />
<br />
[[#top | ReturnToContents]]<br />
<br />
== _FileID ==<br />
<br />
{{Snippet Header<br />
| AuthorURL = 35302-guinness<br />
| AuthorName = guinness<br />
}}<br />
<br />
<syntaxhighlight lang="autoit"><br />
#include <Constants.au3><br />
<br />
FileClose(FileOpen(@ScriptDir & '\ExampleFile.txt', 2))<br />
ConsoleWrite(_FileID(@ScriptDir & '\ExampleFile.txt') & @CRLF)<br />
FileDelete(@ScriptDir & '\ExampleFile.txt')<br />
<br />
; Rerieve the file id of a filepath.<br />
Func _FileID($sFilePath)<br />
Local $iPID = Run(@ComSpec & ' /c fsutil file queryfileid "' & $sFilePath & '"', @SystemDir, @SW_HIDE, $STDOUT_CHILD + $STDERR_CHILD), $sReturn = ''<br />
While 1<br />
$sReturn &= StdoutRead($iPID)<br />
If @error Then<br />
ExitLoop<br />
EndIf<br />
WEnd<br />
Return StringStripWS(StringRegExpReplace($sReturn, 'File\sID\sis\s(.*?)', '$1'), 8)<br />
EndFunc ;==>_FileID<br />
</syntaxhighlight><br />
<br />
[[#top | ReturnToContents]]<br />
<br />
== _FileExistsWithQuotes ==<br />
<br />
{{Snippet Header<br />
| AuthorURL = 35302-guinness<br />
| AuthorName = guinness<br />
}}<br />
<br />
<syntaxhighlight lang="autoit"><br />
ConsoleWrite(_FileExistsWithQuotes('"' & @ScriptDir & '"') & @CRLF)<br />
ConsoleWrite(_FileExistsWithQuotes("'" & @ScriptDir & "'") & @CRLF)<br />
ConsoleWrite(_FileExistsWithQuotes(@ScriptDir) & @CRLF)<br />
<br />
; Version: 1.00. AutoIt: V3.3.8.1<br />
; Check a filepath ecists even if the path contains quotation marks.<br />
Func _FileExistsWithQuotes($sFilePath)<br />
Return FileExists(StringRegExpReplace($sFilePath, '^("|'')*([^"'']+)("|'')*$', '\2'))<br />
EndFunc ;==>_FileExistsWithQuotes<br />
</syntaxhighlight><br />
<br />
[[#top | ReturnToContents]]<br />
<br />
== FileLineCount ==<br />
<br />
{{Snippet Header<br />
| AuthorURL = 71214-mkish<br />
| AuthorName = MKISH<br />
| Desc = Checks the number of lines in a file (useful for larger files as well)<br />
}}<br />
<br />
<syntaxhighlight lang="autoit"><br />
; Author - MKISH<br />
<br />
; Checks the number of lines in a file (useful for larger files as well)<br />
<br />
#include <WinAPI.au3><br />
<br />
Local $FILE = "G:\WIN7\sources\boot.wim"<br />
Local $COUNT = 0<br />
Local $start = default<br />
Local $res, $fLen, $err<br />
<br />
While 1<br />
$res = _HexSearch($FILE, StringToBinary("" & @crlf), $start)<br />
$start = $res + 2<br />
$COUNT = $COUNT + 1<br />
If $res = -1 then exitloop<br />
Wend<br />
<br />
msgbox(64, "", "Lines count: " & $COUNT)<br />
<br />
; _HexSearch function (originally written by Zinthose, modified by MKISH)<br />
Func _HexSearch($FilePath, $BinaryValue, $StartOffset = Default)<br />
Local $Buffer, $ptr, $hFile, $Result, $Read, $SearchValue, $Pos, $BufferSize = 2048<br />
If $StartOffset = Default Then $StartOffset = 0<br />
If Not FileExists($FilePath) Then Return SetError(1, @error, 0)<br />
$fLen = FileGetSize($FilePath)<br />
If $StartOffset > $fLen Then Return SetError(2, @error, 0)<br />
If Not IsBinary($BinaryValue) Then Return SetError(3, @error, 0)<br />
If Not IsNumber($StartOffset) Then Return SetError(4, @error, 0)<br />
$SearchValue = BinaryToString($BinaryValue)<br />
$Buffer = DllStructCreate("byte[" & $BufferSize & "]")<br />
$ptr = DllStructGetPtr($Buffer)<br />
$hFile = _WinAPI_CreateFile($FilePath, 2, 2, 1)<br />
If $hFile = 0 Then Return SetError(5, @error, 0)<br />
$Result = _WinAPI_SetFilePointer($hFile, $StartOffset)<br />
$err = @error<br />
If $Result = 0xFFFFFFFF Then<br />
_WinAPI_CloseHandle($hFile)<br />
Return SetError(5, $err, 0)<br />
EndIf<br />
$Pos = $StartOffset<br />
While True<br />
$Read = 0<br />
$Result = _WinAPI_ReadFile($hFile, $ptr, $BufferSize, $Read)<br />
$err = @error<br />
If Not $Result Then<br />
_WinAPI_CloseHandle($hFile)<br />
Return SetError(6, $err, 0)<br />
EndIf<br />
$Result = DllStructGetData($Buffer, 1)<br />
$Result = BinaryToString($Result)<br />
$Result = StringInStr($Result, $SearchValue)<br />
If $Result > 0 Then ExitLoop<br />
If $Read < $BufferSize Then<br />
_WinAPI_CloseHandle($hFile)<br />
Return -1<br />
EndIf<br />
$Pos += $Read<br />
<br />
WEnd<br />
_WinAPI_CloseHandle($hFile)<br />
If Not $Result Then Return SetError(7, @error, 0)<br />
$Result = $Pos + $Result - 1<br />
Return $Result<br />
EndFunc; ==> _HexSearch<br />
</syntaxhighlight><br />
<br />
[[#top | ReturnToContents]]<br />
<br />
== _FileOpenDialog ==<br />
<br />
{{Snippet Header<br />
| AuthorURL = 35302-guinness<br />
| AuthorName = guinness<br />
}}<br />
<br />
<syntaxhighlight lang="autoit"><br />
Local $sFilePath = _FileOpenDialog("", "", "Images (*.jpg;*.bmp)|Videos (*.avi;*.mpg)", Random(1, @DesktopWidth, 1), Random(1, @DesktopHeight, 1), 1 + 4, "")<br />
<br />
ConsoleWrite('File = ' & $sFilePath & ', @error = ' & @error & @CRLF)<br />
<br />
; #FUNCTION# ====================================================================================================================<br />
; Name ..........: _FileOpenDialog<br />
; Description ...: Initiates a Open File Dialog with the option to set the position of the GUI.<br />
; Syntax ........: _FileOpenDialog($sTitle, $sIntitialDirectory, $sFilter[, $iLeft = -1[, $iTop = -1[, $iOptions = 0[,<br />
; $sDefaultName = ""]]]])<br />
; Parameters ....: $sTitle - Title text of the Dialog GUI.<br />
; $sIntitialDirectory - Initial directory selected in the GUI file tree.<br />
; $sFilter - File type single filter such as "All (*.*)" or "Text files (*.txt)".<br />
; $iLeft - [optional] The left side of the dialog box. By default (-1), the window is centered.<br />
; $iTop - [optional] The top of the dialog box. Default (-1) is centered<br />
; $iOptions - [optional] Dialog Options: To use more than one option, add the required values together. See FileOpenDialog. Default is 0.<br />
; $sDefaultName - [optional] Suggested file name for the user to open. Default is blank ("").<br />
; Return values .: Success: Returns the full path of the file(s) chosen. Results for multiple selections are "Directory|file1|file2|..."<br />
; Failure: Sets @error to non-zero.<br />
; Author ........: guinness<br />
; Remarks........: This doesn't change the working directory of the script like FileOpenDialog does.<br />
; Example .......: Yes<br />
; ===============================================================================================================================<br />
Func _FileOpenDialog($sTitle, $sIntitialDirectory, $sFilter, $iLeft = -1, $iTop = -1, $iOptions = 0, $sDefaultName = "")<br />
Local $hGUI = GUICreate('', -1, -1, $iLeft, $iTop), $sWorkingDir = @WorkingDir<br />
Local $sFilePath = FileOpenDialog($sTitle, $sIntitialDirectory, $sFilter, $iOptions, $sDefaultName, $hGUI)<br />
Local $iError = @error<br />
FileChangeDir($sWorkingDir)<br />
Return SetError($iError, GUIDelete($hGUI), $sFilePath)<br />
EndFunc ;==>_FileOpenDialog()<br />
</syntaxhighlight><br />
<br />
[[#top | ReturnToContents]]<br />
<br />
== _FileRename ==<br />
<br />
{{Snippet Header<br />
| AuthorURL = 52374-johnone<br />
| AuthorName = JohnOne<br />
}}<br />
<br />
<syntaxhighlight lang="autoit"><br />
;### Rename a file ###<br />
;$sFile = Full path to file<br />
;$sRename = New Filename<br />
;$iOverWrite = 0 or 1<br />
<br />
;Success returns 1<br />
;failure, returns 0 and sets @error<br />
; 1 if FileMove fails, <br />
; 2 if $sFile does not exist<br />
;@extended<br />
; 0 if the new file does not already exist / existed<br />
; 1 if the new file already exists / existed<br />
<br />
;#### Example ####<br />
$File = @ScriptDir & '\filetorename.txt'<br />
FileWrite($File, 'Test')<br />
_FileRename($File, 'newname.txt')<br />
If @error Then MsgBox(0, "Error", @error)<br />
<br />
Func _FileRename($sFile, $sRename, $iOverWrite = 0)<br />
Local Const $FILENOTEXIST = 2<br />
If Not FileExists($sFile) Then Return SetError($FILENOTEXIST, 0, 0)<br />
Local $_StringLen = StringLen($sFile)<br />
Local $_StringInStr = StringInStr($sFile, "\", 0, -1, $_StringLen)<br />
Local $_Count = $_StringLen - $_StringInStr<br />
Local $_Dir = StringLeft($sFile, $_StringInStr)<br />
Local $_NewFile = $_Dir & $sRename<br />
Local $_NewFileExists = FileExists($_NewFile)<br />
Local $_FileMove = FileMove($sFile, $_NewFile, $iOverWrite)<br />
Return SetError(Not $_FileMove, $_NewFileExists, $_FileMove)<br />
EndFunc ;==>_FileRename<br />
</syntaxhighlight><br />
<br />
== _FileRename Alternative ==<br />
<br />
<syntaxhighlight lang="autoit"><br />
<br />
;FileRename(PathFile, RenameFile)<br />
;JohnOne<br />
<br />
FileRename(@ScriptDir & "\rename.txt", @ScriptDir & "\renamed.txt")<br />
<br />
Func FileRename($FileName, $ReName)<br />
<br />
Local $SHFILEOPSTRUCT, $SourceStruct, $DestStruct<br />
Local Const $FO_RENAME = 0x0004<br />
Local Const $FOF_SILENT = 0x0004<br />
Local Const $FOF_NOCONFIRMATION = 0x0010<br />
Local Const $FOF_NOERRORUI = 0x0400<br />
Local Const $FOF_NOCONFIRMMKDIR = 0x0200<br />
Local Const $NULL = 0<br />
<br />
$SourceStruct = _StringToStruct($FileName)<br />
$DestStruct = _StringToStruct($ReName)<br />
<br />
$SHFILEOPSTRUCT = DllStructCreate("hwnd hWnd;uint wFunc;ptr pFrom;ptr pTo;int fFlags;int fAnyOperationsAborted;ptr hNameMappings;ptr lpszProgressTitle")<br />
<br />
DllStructSetData($SHFILEOPSTRUCT, "hWnd", $NULL)<br />
DllStructSetData($SHFILEOPSTRUCT, "wFunc", $FO_RENAME)<br />
DllStructSetData($SHFILEOPSTRUCT, "pFrom", DllStructGetPtr($SourceStruct))<br />
DllStructSetData($SHFILEOPSTRUCT, "pTo", DllStructGetPtr($DestStruct))<br />
DllStructSetData($SHFILEOPSTRUCT, "fFlags", BitOR($FOF_SILENT, $FOF_NOCONFIRMATION, $FOF_NOERRORUI, $FOF_NOCONFIRMMKDIR))<br />
DllStructSetData($SHFILEOPSTRUCT, "fAnyOperationsAborted", $NULL)<br />
DllStructSetData($SHFILEOPSTRUCT, "hNameMappings", $NULL)<br />
DllStructSetData($SHFILEOPSTRUCT, "lpszProgressTitle", $NULL)<br />
<br />
$acall = DllCall("shell32.dll", "int", "SHFileOperation", "ptr", DllStructGetPtr($SHFILEOPSTRUCT))<br />
If @error Then<br />
Return SetError(@error, @extended, 0)<br />
EndIf<br />
Return 1<br />
EndFunc ;==>FileRename<br />
<br />
Func _StringToStruct($string)<br />
<br />
Local $iLen = StringLen($string)<br />
Local $Struct = DllStructCreate("char[" & String($iLen + 2) & "]")<br />
DllStructSetData($Struct, 1, $string)<br />
DllStructSetData($Struct, 1, 0, $iLen + 1)<br />
DllStructSetData($Struct, 1, 0, $iLen + 2)<br />
<br />
Return $Struct<br />
EndFunc ;==>_StringToStruct<br />
<br />
</syntaxhighlight><br />
<br />
[[#top | ReturnToContents]]<br />
<br />
== _GetFolderDepth ==<br />
<br />
{{Snippet Header<br />
| AuthorURL = 35302-guinness<br />
| AuthorName = guinness<br />
}}<br />
<br />
<syntaxhighlight lang="autoit"><br />
; Autoit 3.3.5.4 and Below<br />
ConsoleWrite(_GetFolderDepth(@ScriptDir & '') & @CRLF)<br />
ConsoleWrite(_GetFolderDepth(@ScriptDir) & @CRLF)<br />
ConsoleWrite(_GetFolderDepth(@ScriptFullPath) & @CRLF)<br />
<br />
; Get the folder depth of a filepath.<br />
Func _GetFolderDepth($sFilePath)<br />
If StringInStr($sFilePath, '.', 2, -1) Then<br />
$sFilePath = StringLeft($sFilePath, StringInStr($sFilePath, "", 2, -1) - 1)<br />
EndIf<br />
Local $aArray = StringSplit(StringRegExpReplace($sFilePath, '[/]+z', ''), '')<br />
Return $aArray[0] - 1<br />
EndFunc ;==>_GetFolderDepth<br />
</syntaxhighlight><br />
<br />
[[#top | ReturnToContents]]<br />
<br />
== _GetFolderDepth ==<br />
<br />
{{Snippet Header<br />
| AuthorURL = 35302-guinness<br />
| AuthorName = guinness<br />
}}<br />
<br />
<syntaxhighlight lang="autoit"><br />
; Autoit 3.3.5.4 and Above<br />
ConsoleWrite(_GetFolderDepth(@ScriptDir & '') & @CRLF)<br />
ConsoleWrite(_GetFolderDepth(@ScriptDir) & @CRLF)<br />
ConsoleWrite(_GetFolderDepth(@ScriptFullPath) & @CRLF)<br />
<br />
; Get the folder depth of a filepath. Works with V3.3.5.4+<br />
Func _GetFolderDepth($sFilePath)<br />
If StringInStr($sFilePath, '.', 2, -1) Then<br />
$sFilePath = StringLeft($sFilePath, StringInStr($sFilePath, "", 2, -1) - 1)<br />
EndIf<br />
Return StringSplit(StringRegExpReplace($sFilePath, '[/]+z', ''), '')[0] - 1<br />
EndFunc ;==>_GetFolderDepth<br />
</syntaxhighlight><br />
<br />
[[#top | ReturnToContents]]<br />
<br />
== _IsDir ==<br />
<br />
{{Snippet Header<br />
| AuthorURL = 35302-guinness<br />
| AuthorName = guinness<br />
}}<br />
<br />
<syntaxhighlight lang="autoit"><br />
ConsoleWrite("IsDir: Using a file - " & IsDir(@ScriptFullPath) & @CRLF) ; Return 0<br />
ConsoleWrite("IsDir: Using a directory - " & IsDir(@ScriptDir) & @CRLF) ; Return 1<br />
<br />
Func IsDir($sFilePath)<br />
Return Int(FileExists($sFilePath) And StringInStr(FileGetAttrib($sFilePath), 'D', Default, 1) > 0)<br />
EndFunc ;==>IsDir<br />
</syntaxhighlight><br />
<br />
[[#top | ReturnToContents]]<br />
<br />
== _IsFile ==<br />
<br />
{{Snippet Header<br />
| AuthorURL = 35302-guinness<br />
| AuthorName = guinness<br />
}}<br />
<br />
<syntaxhighlight lang="autoit"><br />
ConsoleWrite('IsFile: Using a file - ' & IsFile(@ScriptFullPath) & @CRLF) ; Return 1<br />
ConsoleWrite('IsFile: Using a directory - ' & IsFile(@ScriptDir) & @CRLF) ; Return 0<br />
<br />
Func IsFile($sFilePath)<br />
Return Int(FileExists($sFilePath) And StringInStr(FileGetAttrib($sFilePath), 'D', Default, 1) = 0)<br />
EndFunc ;==>IsFilee<br />
</syntaxhighlight><br />
<br />
[[#top | ReturnToContents]]<br />
<br />
== _IsFileDiff ==<br />
<br />
{{Snippet Header<br />
| AuthorURL = 35302-guinness<br />
| AuthorName = guinness<br />
}}<br />
<br />
<syntaxhighlight lang="autoit"><br />
ConsoleWrite(_IsFileDiff(@ScriptFullPath, @ScriptFullPath) & @CRLF) ; This will return False as the files are exactly the same.<br />
ConsoleWrite(_IsFileDiff(@ScriptFullPath, @AutoItExe) & @CRLF) ; This will return True as the files are different.<br />
<br />
; Check if a file is different.<br />
Func _IsFileDiff($sFilePath_1, $sFilePath_2)<br />
Return RunWait(@ComSpec & ' /c FC /B /W "' & $sFilePath_1 & '" "' & $sFilePath_2 & '"', @WorkingDir, @SW_HIDE) > 0<br />
EndFunc ;==>_IsFileDiff<br />
</syntaxhighlight><br />
<br />
[[#top | ReturnToContents]]<br />
<br />
== _IsFileOlder ==<br />
<br />
{{Snippet Header<br />
| AuthorURL = 35302-guinness<br />
| AuthorName = guinness<br />
}}<br />
<br />
<syntaxhighlight lang="autoit"><br />
#include <Date.au3> ; Required for _DateDiff()<br />
#include <MsgBoxConstants.au3><br />
#include <MsgBoxConstants.au3><br />
<br />
; Check if the current script is older than 10 days.<br />
If _IsFileOlder(@ScriptFullPath, 10) Then<br />
MsgBox($MB_SYSTEMMODAL, '', 'File is older than 10 days.')<br />
Else<br />
MsgBox($MB_SYSTEMMODAL, '', 'File isn''t older than 10 days.')<br />
EndIf<br />
<br />
; Is a file older than a certain number of days.<br />
Func _IsFileOlder($sFilePath, $iDays)<br />
Local $aArray = FileGetTime($sFilePath, $FT_CREATED)<br />
Return _DateDiff('D', $aArray[0] & '/' & $aArray[1] & '/' & $aArray[2] & ' ' & $aArray[3] & ':' & $aArray[4] & ':' & $aArray[5], @YEAR & '/' & @MON & '/' & @MDAY & ' ' & @HOUR & ':' & @MIN & ':' & @SEC) >= $iDays<br />
EndFunc ;==>_IsFileOlder<br />
</syntaxhighlight><br />
<br />
[[#top | ReturnToContents]]<br />
<br />
== _IsFileSame ==<br />
<br />
{{Snippet Header<br />
| AuthorURL = 35302-guinness<br />
| AuthorName = guinness<br />
}}<br />
<br />
<syntaxhighlight lang="autoit"><br />
ConsoleWrite(_IsFileSame(@ScriptFullPath, @ScriptFullPath) & @CRLF) ; This will return True as the files are exactly the same.<br />
ConsoleWrite(_IsFileSame(@ScriptFullPath, @AutoItExe) & @CRLF) ; This will return False as the files are different.<br />
<br />
; Check if a file is the same.<br />
Func _IsFileSame($sFilePath_1, $sFilePath_2)<br />
Return RunWait(@ComSpec & ' /c FC /B /W "' & $sFilePath_1 & '" "' & $sFilePath_2 & '"', @WorkingDir, @SW_HIDE) = 0<br />
EndFunc ;==>_IsFileSame<br />
</syntaxhighlight><br />
<br />
[[#top | ReturnToContents]]<br />
<br />
== _IniReadFile ==<br />
<br />
{{Snippet Header<br />
| AuthorURL = 35302-guinness<br />
| AuthorName = guinness<br />
}}<br />
<br />
<syntaxhighlight lang="autoit"><br />
#include <Array.au3><br />
<br />
__INIFileFill(@ScriptDir & '\Example.ini') ; Create an INI file with random data.<br />
<br />
Local $aArray = _IniReadFile(@ScriptDir & '\Example.ini')<br />
FileDelete(@ScriptDir & '\Example.ini')<br />
_ArrayDisplay($aArray)<br />
<br />
Func _IniReadFile($sFilePath)<br />
Local $aReturn[1][3] = [[0, 3]], $aSectionArray, $aSectionNameArray, $iCount = 0<br />
$aSectionNameArray = IniReadSectionNames($sFilePath)<br />
If @error Then<br />
Return SetError(1, 0, $aReturn)<br />
EndIf<br />
For $A = 1 To $aSectionNameArray[0]<br />
$aSectionArray = IniReadSection($sFilePath, $aSectionNameArray[$A])<br />
If @error Then<br />
ContinueLoop<br />
EndIf<br />
For $B = 1 To $aSectionArray[0][0]<br />
$aReturn[0][0] += 1<br />
$iCount += 1<br />
If $aReturn[0][0] <= $iCount + 1 Then<br />
ReDim $aReturn[$aReturn[0][0] * 2][$aReturn[0][1]]<br />
EndIf<br />
$aReturn[$iCount][0] = $aSectionArray[$B][0]<br />
$aReturn[$iCount][1] = $aSectionArray[$B][1]<br />
$aReturn[$iCount][2] = $aSectionNameArray[$A]<br />
Next<br />
Next<br />
ReDim $aReturn[$aReturn[0][0] + 1][$aReturn[0][1]] ; Remove empty entries.<br />
Return $aReturn<br />
EndFunc ;==>_IniReadFile<br />
<br />
Func __INIFileFill($sFilePath)<br />
Local $sData = '', $sHeader = ''<br />
<br />
For $i = 1 To Random(1, 5, 1)<br />
$sHeader = _RandomText(Random(5, 25, 1))<br />
$sData = ""<br />
For $j = 1 To Random(1, 25, 1)<br />
$sData &= _RandomText(Random(5, 25, 1)) & '=' & _RandomText(Random(5, 25, 1)) & @LF<br />
Next<br />
IniWriteSection($sFilePath, $sHeader, $sData)<br />
Next<br />
EndFunc ;==>__FillINIFile<br />
<br />
Func _RandomText($iLength = 10)<br />
Local $sData = '', $sRandom = ''<br />
For $i = 1 To $iLength<br />
$sRandom = Random(55, 116, 1)<br />
$sData &= Chr($sRandom + 6 * ($sRandom > 90) - 7 * ($sRandom < 65))<br />
Next<br />
Return $sData<br />
EndFunc ;==>_RandomText<br />
</syntaxhighlight><br />
<br />
[[#top | ReturnToContents]]<br />
<br />
== _IniReadInit ==<br />
<br />
{{Snippet Header<br />
| AuthorURL = 9370-mlowery<br />
| AuthorName = mlowery<br />
}}<br />
<br />
<syntaxhighlight lang="autoit"><br />
;===============================================================================<br />
; Description: Reads values from INI or creates INI with initial values.<br />
; Intended to ensure all available INI settings are exposed<br />
; and editable.<br />
; Parameters are identical to IniRead()<br />
; Parameter(s): $filename = filename of INI<br />
; $section = section name of INI<br />
; $key = key name in section<br />
; $default = default value (written to INI if not exists)<br />
; Requirement(s): None<br />
; Return Value(s): Returns value from INI (or default if not defined)<br />
; Note(s): Chr(127) used to detect non-existing value since won't normally exist in a text file<br />
;===============================================================================<br />
Func _IniReadInit($filename, $section, $key, $default)<br />
Local $value = IniRead($filename, $section, $key, Chr(127))<br />
If $value = Chr(127) Then<br />
IniWrite($filename, $section, $key, $default)<br />
$value = $default<br />
EndIf<br />
Return $value<br />
EndFunc<br />
</syntaxhighlight><br />
<br />
[[#top | ReturnToContents]]<br />
<br />
== _IsValidFileType ==<br />
<br />
{{Snippet Header<br />
| AuthorURL = 35302-guinness<br />
| AuthorName = guinness<br />
}}<br />
<br />
<syntaxhighlight lang="autoit"><br />
ConsoleWrite(@ScriptFullPath & " >> " & _IsValidFileType(@ScriptFullPath, "bat;cmd;au3") & @CRLF)<br />
ConsoleWrite(@AutoItExe & " >> " & _IsValidFileType(@AutoItExe, "bat;cmd;au3") & @CRLF)<br />
<br />
; Check if a filepath matches an extension filetype. Based on the idea by guinness - http://www.autoitscript.com/forum/topic/123674-isvalidfiletype/<br />
Func _IsValidFileType($sFilePath, $sList = "bat;cmd;exe") ; By AZJIO - http://www.autoitscript.com/forum/topic/...filetype/page__view__findpost_<br />
Local $iDot = StringInStr($sFilePath, ".", 0, -1)<br />
Return $iDot And StringInStr(';' & $sList & ';', ';' & StringTrimLeft($sFilePath, $iDot) & ';') > 0<br />
EndFunc ;==>_IsValidFileType<br />
</syntaxhighlight><br />
<br />
<syntaxhighlight lang="autoit"><br />
; Example 2<br />
<br />
#include <WinAPIEx.au3><br />
<br />
ConsoleWrite(@ScriptFullPath & " >> " & _IsValidFileType(@ScriptFullPath, "bat;cmd;au3") & @CRLF)<br />
ConsoleWrite(@AutoItExe & " >> " & _IsValidFileType(@AutoItExe, "bat;cmd;au3") & @CRLF)<br />
<br />
; Check if a filepath matches an extension filetype. Based on the idea by guinness - http://www.autoitscript.com/forum/topic/123674-isvalidfiletype/<br />
Func _IsValidFileType($sFilePath, $sList = "bat;cmd;exe", $iOpFast = 1) ; By Yashied.<br />
If StringStripWS($sList, 8) = "" Then<br />
$sList = "*"<br />
EndIf<br />
Return _WinAPI_PathMatchSpec($sFilePath, StringReplace(';' & $sList, ';', ';*.', 0, $iOpFast * 2))<br />
EndFunc ;==>_IsValidFileType<br />
</syntaxhighlight><br />
<br />
[[#top | ReturnToContents]]<br />
<br />
== File Open/Save/Folder Dialog Box ==<br />
<br />
{{Snippet Header<br />
| AuthorURL = 2709-mhz<br />
| AuthorName = MHz<br />
| AuthorURL2 = 4997-odklizec<br />
| AuthorName2 = odklizec<br />
| AuthorURL3 = 6756-danny35d<br />
| AuthorName3 = Danny35d<br />
}}<br />
<br />
<syntaxhighlight lang="autoit"><br />
; Center - File Open/Save/Folder Dialog Box<br />
; Author - odklizec, MHz, Danny35d<br />
<br />
If StringInStr($cmdlineraw, '/MoveWin') Then<br />
Local $size, $PosX, $PosY<br />
$cmdlineraw = StringSplit(StringMid($cmdlineraw, StringInStr($cmdlineraw, '/MoveWin')), ':')<br />
While 1<br />
Select<br />
Case WinExists($cmdlineraw[2])<br />
$size=WinGetPos ($cmdlineraw[2])<br />
$PosX=@DesktopWidth/2 - $size[2]/2<br />
$PosY=@DesktopHeight/2 - $size[3]/2<br />
WinMove($cmdlineraw[2], "", $PosX, $PosY)<br />
WinActivate($cmdlineraw[2])<br />
ExitLoop<br />
EndSelect<br />
Sleep(50)<br />
WEnd<br />
Exit<br />
EndIf<br />
Global $PID, $Read_File, $Save_File<br />
$PID = _FindBrowseWin('Open file Dialog Box')<br />
$Read_File = FileOpenDialog ( "Open file Dialog Box", @ScriptDir & "\", "AutoIt Files (*.au3)",3,@ScriptFullPath)<br />
ProcessClose($PID)<br />
$PID = _FindBrowseWin('Save file Dialog Box')<br />
$Save_File = FileSaveDialog( "Save file Dialog Box", @ScriptDir, "Scripts (*.aut;*.au3)", 3)<br />
ProcessClose($PID)<br />
$PID = _FindBrowseWin('Browse for Folder')<br />
FileSelectFolder("Choose a folder with plugins..", "","4","c:\")<br />
ProcessClose($PID)<br />
<br />
Func _FindBrowseWin($sTitle)<br />
If @Compiled Then<br />
Return(Run(@ScriptFullPath & ' /MoveWin:' & $sTitle))<br />
Else<br />
Return(Run(@AutoItExe & ' "' & @ScriptFullPath & '" /MoveWin:' & $sTitle))<br />
EndIf<br />
EndFunc<br />
</syntaxhighlight><br />
<br />
[[#top | ReturnToContents]]<br />
<br />
== _MoveFileOnReboot ==<br />
<br />
{{Snippet Header<br />
| AuthorURL = 44525-jscript<br />
| AuthorName = JScript<br />
}}<br />
<br />
<syntaxhighlight lang="autoit"><br />
;Author: JScript - Snippet Version No. = 1.0<br />
;Snippet was Created Using AutoIt Version = 3.3.2.0, Creation Date = 21/03/12.<br />
<br />
; Function to Move or Delete a file on next reboot!<br />
Func _MoveFileOnReboot($sSourcePath, $sDestPath = ""); If $sDestPath = "" the file is deleted instead of moved.<br />
Local $iRet<br />
<br />
; PendingFileRenameOperations (HKLM\SYSTEM\CurrentControlSet\Control\Session Manager)<br />
If $DestPath = "" Then<br />
$iRet = DllCall("kernel32.dll", "int", "MoveFileExA", "str", $sSourcePath, "int", 0, "dword", 4)<br />
Else<br />
$iRet = DllCall("kernel32.dll", "int", "MoveFileExA", "str", $sSourcePath, "str", $sDestPath, "dword", 4)<br />
EndIf<br />
<br />
Return $iRet<br />
EndFunc ;==>_MoveFileOnReboot<br />
</syntaxhighlight><br />
<br />
[[#top | ReturnToContents]]<br />
<br />
== _MultipleFileOpenDialog ==<br />
<br />
{{Snippet Header<br />
| AuthorURL =<br />
| AuthorName = /dev/null<br />
}}<br />
<br />
<syntaxhighlight lang="autoit"><br />
Local $message = "Hold down Ctrl or Shift to choose multiple files."<br />
<br />
Local $filename = _MultipleFileOpenDialog($message,300,300)<br />
<br />
Local $var = FileOpenDialog($message, @WindowsDir & "\", "Images (*.jpg;*.bmp)", 1 + 4 )<br />
<br />
If @error Then<br />
MsgBox(4096,"","No File(s) chosen")<br />
Else<br />
$var = StringReplace($var, "|", @CRLF)<br />
MsgBox(4096,"","You chose " & $var)<br />
EndIf<br />
<br />
FileDelete($filename)<br />
func _MultipleFileOpenDialog($title,$posx,$posy)<br />
Local $temp = EnvGet("temp")<br />
Local $filename = $temp & "\move_file_open_dialog.au3"<br />
<br />
Local $script = 'Global $title = "' & $title & '"' & @CRLF<br />
$script &= 'Global $pos_x = ' & $posx & @CRLF<br />
$script &= 'Global $pos_y = ' & $posy & @CRLF<br />
$script &= 'AdlibRegister("_Move",10)' & @CRLF<br />
$script &= 'while 1' & @CRLF<br />
$script &= ' sleep(1000)' & @CRLF<br />
$script &= 'wend' & @CRLF<br />
$script &= 'Func _Move()' & @CRLF<br />
$script &= ' if (WinActive($title)) Then' & @CRLF<br />
$script &= ' WinMove($title,"",$pos_x,$pos_y)' & @CRLF<br />
$script &= ' Exit' & @CRLF<br />
$script &= ' EndIf' & @CRLF<br />
$script &= 'EndFunc' & @CRLF<br />
<br />
FileWrite($filename,$script)<br />
;MsgBox(0,"",$script & @CRLF & $filename)<br />
Run(@AutoItExe & " /AutoIt3ExecuteScript " & $filename)<br />
sleep(250)<br />
Return $filename<br />
EndFunc ;==>_MultipleFileOpenDialog()<br />
</syntaxhighlight><br />
<br />
[[#top | ReturnToContents]]<br />
<br />
== _OpenFolder ==<br />
<br />
{{Snippet Header<br />
| AuthorURL = 35302-guinness<br />
| AuthorName = guinness<br />
}}<br />
<br />
<syntaxhighlight lang="autoit"><br />
#cs<br />
These have been declared in Global scope as you may wish to use them elsewhere in your script.<br />
#ce<br />
Global $ALTSTARTUP = 0x1d<br />
Global $APPDATA = 0x1a<br />
Global $BITBUCKET = 0x0a<br />
Global $COMMONALTSTARTUP = 0x1e<br />
Global $COMMONAPPDATA = 0x23<br />
Global $COMMONDESKTOPDIR = 0x19<br />
Global $COMMONFAVORITES = 0x1f<br />
Global $COMMONPROGRAMS = 0x17<br />
Global $COMMONSTARTMENU = 0x16<br />
Global $COMMONSTARTUP = 0x18<br />
Global $CONTROLS = 0x03<br />
Global $COOKIES = 0x21<br />
Global $DESKTOP = 0x00<br />
Global $DESKTOPDIRECTORY = 0x10<br />
Global $DRIVES = 0x11<br />
Global $FAVORITES = 0x06<br />
Global $FONTS = 0x14<br />
Global $HISTORY = 0x22<br />
Global $INTERNETCACHE = 0x20<br />
Global $LOCALAPPDATA = 0x1c<br />
Global $MYPICTURES = 0x27<br />
Global $NETHOOD = 0x13<br />
Global $NETWORK = 0x12<br />
Global $PERSONAL = 0x05<br />
Global $PRINTERS = 0x04<br />
Global $PRINTHOOD = 0x1b<br />
Global $PROFILE = 0x28<br />
Global $PROGRAMFILES = 0x26<br />
Global $PROGRAMFILESx86 = 0x30<br />
Global $PROGRAMS = 0x02<br />
Global $RECENT = 0x08<br />
Global $SENDTO = 0x09<br />
Global $STARTMENU = 0x0b<br />
Global $STARTUP = 0x07<br />
Global $SYSTEM = 0x25<br />
Global $SYSTEMx86 = 0x29<br />
Global $TEMPLATES = 0x15<br />
Global $WINDOWS = 0x24<br />
<br />
ConsoleWrite(_OpenFolder(@ScriptDir) & @CRLF)<br />
ConsoleWrite(_OpenFolder($PRINTERS) & @CRLF)<br />
<br />
; Open a folder or special folder variable, similar to using ShellExecute.<br />
Func _OpenFolder($sFolderPath)<br />
Local $oShell = ObjCreate('shell.application')<br />
If @error Then<br />
Return SetError(1, 0, 0)<br />
EndIf<br />
$oShell.Open($sFolderPath)<br />
Return 1<br />
EndFunc ;==>_OpenFolder<br />
</syntaxhighlight><br />
<br />
[[#top | ReturnToContents]]<br />
<br />
== _PathAppendToFilename ==<br />
<br />
{{Snippet Header<br />
| AuthorURL = 31965-progandy<br />
| AuthorName = ProgAndy<br />
}}<br />
<br />
<syntaxhighlight lang="autoit"><br />
$sOrg = "C:\Some.Folder\some.file.ext"<br />
$sAdd = "_backup"<br />
<br />
$sNew = _PathAppendToFilename($sOrg, $sAdd)<br />
<br />
$sStripped = _PathStripRightFromFilename($sNew, $sAdd)<br />
<br />
MsgBox(0, "", $sOrg & @CRLF & $sAdd & @CRLF & $sNew & @CRLF & $sStripped)<br />
<br />
Func _PathAppendToFilename($sName, $sAppend)<br />
; Author: ProgAndy<br />
If StringRegExp($sAppend, '[\/\\:\?"<>\|\*]') Then Return SetError(1, 0, $sName)<br />
Return StringRegExpReplace($sName, "(\.[^\\/\.]+)$", $sAppend & "\1", 1)<br />
EndFunc<br />
</syntaxhighlight><br />
<br />
[[#top | ReturnToContents]]<br />
<br />
== _PathStripRightFromFilename ==<br />
<br />
{{Snippet Header<br />
| AuthorURL = 31965-progandy<br />
| AuthorName = ProgAndy<br />
}}<br />
<br />
<syntaxhighlight lang="autoit"><br />
Func _PathStripRightFromFilename($sName, $sStrip)<br />
; Author: ProgAndy<br />
If StringRegExp($sStrip, '[\/\\:\?"<>\|\*]') Then Return SetError(1, 0, $sName)<br />
Return StringRegExpReplace($sName, "\Q" & $sStrip & "\E(\.[^\\/\.]+)$", "\1", 1)<br />
EndFunc<br />
</syntaxhighlight><br />
<br />
[[#top | ReturnToContents]]<br />
<br />
== _SelfDelete ==<br />
<br />
{{Snippet Header<br />
| AuthorURL = 2709-mhz<br />
| AuthorName = MHz<br />
}}<br />
<br />
<syntaxhighlight lang="autoit"><br />
; This also removes the directory which the file is in<br />
; Author MHz with the directory delete addition by The Kandie Man<br />
Func _SelfDelete($iDelay = 0)<br />
Local $sCmdFile<br />
FileDelete(@TempDir & "\scratch.bat")<br />
$sCmdFile = 'ping -n ' & $iDelay & '127.0.0.1 > nul' & @CRLF _<br />
& ':loop' & @CRLF _<br />
& 'del "' & @ScriptFullPath & '"' & @CRLF _<br />
& 'if exist "' & @ScriptFullPath & '" goto loop' & @CRLF _<br />
& ':loop2' & @CRLF _<br />
& 'rmdir /q "' & $dirToDelete & '"' & @CRLF _<br />
& 'if exist "' & $dirToDelete & '" goto loop2' & @CRLF _<br />
& 'del ' & @TempDir & '\scratch.bat'<br />
FileWrite(@TempDir & "\scratch.bat", $sCmdFile)<br />
Run(@TempDir & "\scratch.bat", @TempDir, @SW_HIDE)<br />
EndFunc<br />
</syntaxhighlight><br />
<br />
[[#top | ReturnToContents]]<br />
<br />
== _ShellExecuteFileSelectFolder ==<br />
<br />
{{Snippet Header<br />
| AuthorURL = 35302-guinness<br />
| AuthorName = guinness<br />
}}<br />
<br />
<syntaxhighlight lang="autoit"><br />
ConsoleWrite(_ShellExecuteFileSelectFolder('Select a Folder', @HomeDrive) & @CRLF)<br />
<br />
; Shell Execute a selected folder.<br />
Func _ShellExecuteFileSelectFolder($sText, $sRoot, $iFlag = 0, $sInitialDir = '', $hWnd = '')<br />
Local $sFolder = FileSelectFolder($sText, $sRoot, $iFlag, $sInitialDir, $hWnd)<br />
If @error Then<br />
Return SetError(@error, @extended, '')<br />
EndIf<br />
ShellExecute($sFolder)<br />
Return $sFolder<br />
EndFunc ;==>_ShellExecuteFileSelectFolder<br />
</syntaxhighlight><br />
<br />
[[#top | ReturnToContents]]<br />
<br />
== _SuiCide ==<br />
<br />
{{Snippet Header<br />
| AuthorURL = 28010-larrydalooza<br />
| AuthorName = LarryDalooza<br />
}}<br />
<br />
<syntaxhighlight lang="autoit"><br />
; IMPORTANT MAKE A COPY OF SCRIPT BEFORE DELETION<br />
; Deletes the running script<br />
<br />
Func SuiCide()<br />
Local $sFilePath = @TempDir & '\SuiCide.bat'<br />
FileDelete($sFilePath)<br />
FileWrite($sFilePath, 'loop:' & @CRLF & 'del "' & @ScriptFullPath & '"' & @CRLF & _<br />
'ping -n 1 -w 250 zxywqxz_q' & @CRLF & 'if exist "' & @ScriptFullPath & _<br />
'" goto loop' & @CRLF & 'del SuiCide.bat' & @CRLF)<br />
Exit Run($sFilePath, @TempDir, @SW_HIDE)<br />
EndFunc ;==>SuiCide<br />
</syntaxhighlight><br />
<br />
[[#top | ReturnToContents]]<br />
<br />
== _UniqueFilename ==<br />
<br />
{{Snippet Header<br />
| AuthorURL = 35302-guinness<br />
| AuthorName = guinness<br />
}}<br />
<br />
<syntaxhighlight lang="autoit"><br />
<br />
ConsoleWrite(_UniqueFilename(@ScriptDir, '.au3') & @CRLF)<br />
<br />
Func _UniqueFilename($sFilePath, $sExtension)<br />
Local $iRandom = 0, $sUnqiueFileName = ''<br />
<br />
$sExtension = '.' & StringRegExpReplace($sExtension, '\A[\.]+', '')<br />
$sFilePath = StringRegExpReplace($sFilePath, '[\\/]+\z', '') & '\'<br />
While 1<br />
$iRandom = Random(55, 116, 1)<br />
$sUnqiueFileName &= Chr($iRandom + 6 * ($iRandom > 90) - 7 * ($iRandom < 65))<br />
If FileExists($sFilePath & $sUnqiueFileName & $sExtension) = 0 And StringLen($sUnqiueFileName) > 7 Then<br />
ExitLoop<br />
EndIf<br />
WEnd<br />
Return $sFilePath & $sUnqiueFileName & $sExtension<br />
EndFunc ;==>_UniqueFilename<br />
</syntaxhighlight><br />
<br />
[[#top | ReturnToContents]]<br />
<br />
== Windows - Copy With Progress ==<br />
<br />
{{Snippet Header<br />
| AuthorURL = 19-jos<br />
| AuthorName = Jos<br />
}}<br />
<br />
<syntaxhighlight lang="autoit"><br />
; Windows - Copy With Progress<br />
<br />
;~ 4 Do not display a progress dialog box.<br />
;~ 8 Give the file being operated on a new name in a move, copy, or rename operation if a file with the target name already exists.<br />
;~ 16 Respond with "Yes to All" for any dialog box that is displayed.<br />
;~ 64 Preserve undo information, if possible.<br />
;~ 128 Perform the operation on files only if a wildcard file name (*.*) is specified.<br />
;~ 256 Display a progress dialog box but do not show the file names.<br />
;~ 512 Do not confirm the creation of a new directory if the operation requires one to be created.<br />
;~ 1024 Do not display a user interface if an error occurs.<br />
;~ 2048 Version 4.71. Do not copy the security attributes of the file.<br />
;~ 4096 Only operate in the local directory. Don't operate recursively into subdirectories.<br />
;~ 8192 Version 5.0. Do not copy connected files as a group. Only copy the specified files.<br />
<br />
_FileCopy("C:\Installed Apps\Patches\WindowsXP-KB835935-SP2-ENU.exe","C:\temp")<br />
<br />
; to copy a directory the destination directory must exist<br />
<br />
Func _FileCopy($fromFile,$tofile)<br />
Local $FOF_RESPOND_YES = 16<br />
Local $FOF_SIMPLEPROGRESS = 256<br />
$winShell = ObjCreate("shell.application")<br />
$winShell.namespace($tofile).CopyHere($fromFile,$FOF_RESPOND_YES)<br />
EndFunc<br />
</syntaxhighlight><br />
<br />
<br />
<br />
== Windows - Built In ZIP and Unzip (Windows Shell) ==<br />
<br />
{{Snippet Header<br />
| AuthorName = Nine<br />
}}<br />
<br />
<syntaxhighlight lang="autoit"><br />
#include <Constants.au3><br />
#include <String.au3><br />
<br />
Opt("MustDeclareVars", 1)<br />
<br />
Const $sZipFile = @ScriptDir & "\Test.zip"<br />
Const $sFolder = @ScriptDir & "\Temp"<br />
Const $sZipNew = @ScriptDir & "\Test2.zip"<br />
<br />
DirRemove ($sFolder, $DIR_REMOVE)<br />
UnZip($sZipFile, $sFolder)<br />
If @error Then Exit MsgBox ($MB_SYSTEMMODAL,"","Error unzipping files : " & @error)<br />
FileDelete ($sZipNew)<br />
Zip ($sZipFile, $sFolder)<br />
If @error Then Exit MsgBox ($MB_SYSTEMMODAL,"","Error zipping files : " & @error)<br />
<br />
Func UnZip($sZipFile, $sDestFolder)<br />
If Not FileExists($sZipFile) Then Return SetError (1) ; source file does not exists<br />
If Not FileExists($sDestFolder) Then<br />
If Not DirCreate($sDestFolder) Then Return SetError (2) ; unable to create destination<br />
Else<br />
If Not StringInStr(FileGetAttrib($sDestFolder), "D") Then Return SetError (3) ; destination not folder<br />
EndIf<br />
Local $oShell = ObjCreate("shell.application")<br />
Local $oZip = $oShell.NameSpace($sZipFile)<br />
Local $iZipFileCount = $oZip.items.Count<br />
If Not $iZipFileCount Then Return SetError (4) ; zip file empty<br />
For $oFile In $oZip.items<br />
$oShell.NameSpace($sDestFolder).copyhere($ofile)<br />
Next<br />
EndFunc ;==>UnZip<br />
<br />
Func Zip ($sZipFile, $sSourceFolder)<br />
If FileExists($sZipFile) Then Return SetError (1) ; destination file already exists<br />
If Not FileExists($sSourceFolder) Then Return SetError (2) ; source does not exist<br />
Local $hFile = FileOpen ($sZipFile, $FO_CREATEPATH+$FO_OVERWRITE+$FO_BINARY)<br />
Local Const $sString = Chr(80) & Chr(75) & Chr(5) & Chr(6) & _StringRepeat (Chr(0), 18) ; create ZIP file signature<br />
FileWrite ($hFile, $sString)<br />
FileClose($hFile)<br />
Local $oShell = ObjCreate("shell.application")<br />
If Not $oShell.NameSpace ($sSourceFolder).items.count Then Return SetError (3) ; folder empty<br />
Local $iFiles = 0<br />
For $oFile In $oShell.NameSpace($sSourceFolder).items<br />
$oShell.NameSpace($sZipFile).copyhere($oFile)<br />
Do<br />
Sleep (100) ; let the file being copied to ZIP<br />
Until $oShell.NameSpace($sZipFile).items.count > $iFiles<br />
$iFiles = $oShell.NameSpace($sZipFile).items.count<br />
Next<br />
EndFunc<br />
</syntaxhighlight><br />
<br />
<br />
[[#top | ReturnToContents]]</div>Skysnakehttps://www.autoitscript.com/w/index.php?title=Snippets_(_Files_%26_Folders_)&diff=14390Snippets ( Files & Folders )2020-08-31T09:18:09Z<p>Skysnake: Added at the end Windows - Built In Unzip (Windows Shell)</p>
<hr />
<div>__TOC__<br />
[[category:Snippets]]<br />
<br />
{{Snippet Credit Header}}<br />
<br />
== _ConvertFileToUTF16 ==<br />
<br />
{{Snippet Header<br />
| AuthorURL = 35302-guinness<br />
| AuthorName = guinness<br />
}}<br />
<br />
<syntaxhighlight lang="autoit"><br />
_ConvertFileToUTF16(@ScriptDir & "\Example.xml")<br />
<br />
Func _ConvertFileToUTF16($sFilePath)<br />
Local $iEncoding = FileGetEncoding($sFilePath)<br />
Local $hFileOpen = FileOpen($sFilePath, $iEncoding)<br />
If $hFileOpen = -1 Then<br />
Return SetError(1, 0, 0)<br />
EndIf<br />
Local $sData = FileRead($hFileOpen)<br />
FileClose($hFileOpen)<br />
<br />
$hFileOpen = FileOpen($sFilePath, 2 + 32)<br />
If $hFileOpen = -1 Then<br />
Return SetError(2, 0, 0)<br />
EndIf<br />
FileWrite($hFileOpen, $sData)<br />
Return FileClose($hFileOpen)<br />
EndFunc ;==>_ConvertFileToUTF16<br />
</syntaxhighlight><br />
<br />
[[#top | ReturnToContents]]<br />
<br />
== DropFiles ==<br />
<br />
{{Snippet Header<br />
| AuthorURL = 35302-guinness<br />
| AuthorName = guinness<br />
| Desc = Dropping multiple files onto a GUI<br />
}}<br />
<br />
<syntaxhighlight lang="autoit"><br />
; Dropping multiple files onto a GUI<br />
<br />
#include <APIConstants.au3><br />
#include <Array.au3><br />
#include <GUIConstantsEx.au3><br />
#include <WinAPIEx.au3><br />
<br />
Global $__aDropFiles<br />
<br />
Example()<br />
<br />
Func Example()<br />
Local $hGUI = GUICreate('', 500, 500, -1, -1, -1, $WS_EX_ACCEPTFILES)<br />
<br />
; Create a label that is transparent which will accept 'drop' events.<br />
GUICtrlCreateLabel("", 0, 0, 500, 500)<br />
GUICtrlSetBkColor(-1, $GUI_BKCOLOR_TRANSPARENT)<br />
GUICtrlSetResizing(-1, $GUI_DOCKALL)<br />
GUICtrlSetState(-1, $GUI_DROPACCEPTED)<br />
<br />
GUIRegisterMsg($WM_DROPFILES, "WM_DROPFILES")<br />
GUISetState(@SW_SHOW, $hGUI)<br />
<br />
While 1<br />
Switch GUIGetMsg()<br />
Case $GUI_EVENT_CLOSE<br />
ExitLoop<br />
<br />
Case $GUI_EVENT_DROPPED<br />
If $__aDropFiles[0] > 0 Then<br />
_ArrayDisplay($__aDropFiles)<br />
EndIf<br />
<br />
EndSwitch<br />
WEnd<br />
GUIDelete($hGUI)<br />
EndFunc ;==>Example<br />
<br />
Func WM_DROPFILES($hWnd, $iMsg, $iwParam, $ilParam)<br />
#forceref $hWnd, $ilParam<br />
Switch $iMsg<br />
Case $WM_DROPFILES<br />
Local $aReturn = _WinAPI_DragQueryFileEx($iwParam)<br />
If IsArray($aReturn) Then<br />
$__aDropFiles = $aReturn<br />
Else<br />
Local $aError[1] = [0]<br />
$__aDropFiles = $aError<br />
EndIf<br />
EndSwitch<br />
Return $GUI_RUNDEFMSG<br />
EndFunc ;==>WM_DROPFILES<br />
</syntaxhighlight><br />
<br />
[[#top | ReturnToContents]]<br />
<br />
== _ExitCheckTextChange ==<br />
<br />
{{Snippet Header<br />
| AuthorURL = 8007-negativenrg<br />
| AuthorName = NegativeNrG<br />
}}<br />
<br />
<syntaxhighlight lang="autoit"><br />
;Check(when Exit), if Text is not equal to $e_to Then, prompt the user to save or not save.<br />
;_ExitCheckText Change $Edit Handle, $title of messagebox, $message of messagebox, $equal to(default = NULL).<br />
<br />
Func _ExitCheckTextChange($E_hnd,$title,$message,$e_to = '')<br />
Local $buffer, $choice, $filetosave, $handle1<br />
$buffer = GUIctrlread($E_hnd)<br />
If $buffer <> $e_to Then<br />
$choice = Msgbox(4,$title,$message)<br />
If $choice = 6 Then<br />
$filetosave = FileSaveDialog('Choose File',@scriptdir,'(*.au3)')<br />
$handle1 = FileOpen($filetosave,2)<br />
FileWrite($handle1,$buffer)<br />
Exit<br />
Elseif $choice <> 6 Then<br />
Exit<br />
EndIf<br />
Else<br />
Exit<br />
EndIf<br />
EndFunc<br />
</syntaxhighlight><br />
<br />
[[#top | ReturnToContents]]<br />
<br />
== _FileDeleteEx ==<br />
<br />
{{Snippet Header<br />
| AuthorURL = 35302-guinness<br />
| AuthorName = guinness<br />
}}<br />
<br />
<syntaxhighlight lang="autoit"><br />
; Ref: http://msdn.microsoft.com/en-us/library/windows/desktop/aa365240(v=vs.85).aspx<br />
<br />
#include <APIFilesConstants.au3><br />
#include <WinAPIFiles.au3><br />
<br />
ConsoleWrite(_FileDeleteEx("C:\Example.dat") & @CRLF)<br />
<br />
Func _FileDeleteEx($sFilePath)<br />
Return FileDelete($sFilePath) = 1 ? 1 : Int(_WinAPI_MoveFileEx(FileGetShortName($sFilePath), "", $MOVE_FILE_DELAY_UNTIL_REBOOT))<br />
EndFunc ;==>_FileDeleteEx<br />
</syntaxhighlight><br />
<br />
[[#top | ReturnToContents]]<br />
<br />
== _FileCheck ==<br />
<br />
{{Snippet Header<br />
| AuthorURL = 35302-guinness<br />
| AuthorName = guinness<br />
}}<br />
<br />
<syntaxhighlight lang="autoit"><br />
#include <Date.au3><br />
<br />
; Check if the file was modified less than 24 hours ago.<br />
ConsoleWrite( _FileCheck(@ScriptFullPath, 24) & @CRLF)<br />
<br />
Func _FileCheck($sFilePath, $iHours = 24)<br />
Local $aTime<br />
If FileExists($sFilePath) = 0 Then<br />
Return SetError(1, 0, 0)<br />
EndIf<br />
$aTime = FileGetTime($sFilePath, 0, 0)<br />
Return Number(_DateDiff("h", $aTime[0] & "/" & $aTime[1] & "/" & $aTime[2] & " " & $aTime[3] & ":" & $aTime[4] & ":" & $aTime[5], @YEAR & "/" & @MON & "/" & @MDAY & " " & @HOUR & ":" & @MIN & ":" & @SEC) < $iHours)<br />
EndFunc ;==>_FileCheck<br />
</syntaxhighlight><br />
<br />
[[#top | ReturnToContents]]<br />
<br />
== _FileCreateEx ==<br />
<br />
{{Snippet Header<br />
| AuthorURL = 35302-guinness<br />
| AuthorName = guinness<br />
}}<br />
<br />
<syntaxhighlight lang="autoit"><br />
_FileCreateEx(@ScriptDir & '\ExampleFile.txt', 42)<br />
<br />
; Create a blank file with a certain size in bytes.<br />
Func _FileCreateEx($sFilePath, $iBytes = 0)<br />
Return RunWait(@ComSpec & ' /c fsutil file createnew "' & $sFilePath & '" ' & Int($iBytes), @WorkingDir, @SW_HIDE)<br />
EndFunc ;==>_FileCreateEx<br />
</syntaxhighlight><br />
<br />
[[#top | ReturnToContents]]<br />
<br />
== _FileID ==<br />
<br />
{{Snippet Header<br />
| AuthorURL = 35302-guinness<br />
| AuthorName = guinness<br />
}}<br />
<br />
<syntaxhighlight lang="autoit"><br />
#include <Constants.au3><br />
<br />
FileClose(FileOpen(@ScriptDir & '\ExampleFile.txt', 2))<br />
ConsoleWrite(_FileID(@ScriptDir & '\ExampleFile.txt') & @CRLF)<br />
FileDelete(@ScriptDir & '\ExampleFile.txt')<br />
<br />
; Rerieve the file id of a filepath.<br />
Func _FileID($sFilePath)<br />
Local $iPID = Run(@ComSpec & ' /c fsutil file queryfileid "' & $sFilePath & '"', @SystemDir, @SW_HIDE, $STDOUT_CHILD + $STDERR_CHILD), $sReturn = ''<br />
While 1<br />
$sReturn &= StdoutRead($iPID)<br />
If @error Then<br />
ExitLoop<br />
EndIf<br />
WEnd<br />
Return StringStripWS(StringRegExpReplace($sReturn, 'File\sID\sis\s(.*?)', '$1'), 8)<br />
EndFunc ;==>_FileID<br />
</syntaxhighlight><br />
<br />
[[#top | ReturnToContents]]<br />
<br />
== _FileExistsWithQuotes ==<br />
<br />
{{Snippet Header<br />
| AuthorURL = 35302-guinness<br />
| AuthorName = guinness<br />
}}<br />
<br />
<syntaxhighlight lang="autoit"><br />
ConsoleWrite(_FileExistsWithQuotes('"' & @ScriptDir & '"') & @CRLF)<br />
ConsoleWrite(_FileExistsWithQuotes("'" & @ScriptDir & "'") & @CRLF)<br />
ConsoleWrite(_FileExistsWithQuotes(@ScriptDir) & @CRLF)<br />
<br />
; Version: 1.00. AutoIt: V3.3.8.1<br />
; Check a filepath ecists even if the path contains quotation marks.<br />
Func _FileExistsWithQuotes($sFilePath)<br />
Return FileExists(StringRegExpReplace($sFilePath, '^("|'')*([^"'']+)("|'')*$', '\2'))<br />
EndFunc ;==>_FileExistsWithQuotes<br />
</syntaxhighlight><br />
<br />
[[#top | ReturnToContents]]<br />
<br />
== FileLineCount ==<br />
<br />
{{Snippet Header<br />
| AuthorURL = 71214-mkish<br />
| AuthorName = MKISH<br />
| Desc = Checks the number of lines in a file (useful for larger files as well)<br />
}}<br />
<br />
<syntaxhighlight lang="autoit"><br />
; Author - MKISH<br />
<br />
; Checks the number of lines in a file (useful for larger files as well)<br />
<br />
#include <WinAPI.au3><br />
<br />
Local $FILE = "G:\WIN7\sources\boot.wim"<br />
Local $COUNT = 0<br />
Local $start = default<br />
Local $res, $fLen, $err<br />
<br />
While 1<br />
$res = _HexSearch($FILE, StringToBinary("" & @crlf), $start)<br />
$start = $res + 2<br />
$COUNT = $COUNT + 1<br />
If $res = -1 then exitloop<br />
Wend<br />
<br />
msgbox(64, "", "Lines count: " & $COUNT)<br />
<br />
; _HexSearch function (originally written by Zinthose, modified by MKISH)<br />
Func _HexSearch($FilePath, $BinaryValue, $StartOffset = Default)<br />
Local $Buffer, $ptr, $hFile, $Result, $Read, $SearchValue, $Pos, $BufferSize = 2048<br />
If $StartOffset = Default Then $StartOffset = 0<br />
If Not FileExists($FilePath) Then Return SetError(1, @error, 0)<br />
$fLen = FileGetSize($FilePath)<br />
If $StartOffset > $fLen Then Return SetError(2, @error, 0)<br />
If Not IsBinary($BinaryValue) Then Return SetError(3, @error, 0)<br />
If Not IsNumber($StartOffset) Then Return SetError(4, @error, 0)<br />
$SearchValue = BinaryToString($BinaryValue)<br />
$Buffer = DllStructCreate("byte[" & $BufferSize & "]")<br />
$ptr = DllStructGetPtr($Buffer)<br />
$hFile = _WinAPI_CreateFile($FilePath, 2, 2, 1)<br />
If $hFile = 0 Then Return SetError(5, @error, 0)<br />
$Result = _WinAPI_SetFilePointer($hFile, $StartOffset)<br />
$err = @error<br />
If $Result = 0xFFFFFFFF Then<br />
_WinAPI_CloseHandle($hFile)<br />
Return SetError(5, $err, 0)<br />
EndIf<br />
$Pos = $StartOffset<br />
While True<br />
$Read = 0<br />
$Result = _WinAPI_ReadFile($hFile, $ptr, $BufferSize, $Read)<br />
$err = @error<br />
If Not $Result Then<br />
_WinAPI_CloseHandle($hFile)<br />
Return SetError(6, $err, 0)<br />
EndIf<br />
$Result = DllStructGetData($Buffer, 1)<br />
$Result = BinaryToString($Result)<br />
$Result = StringInStr($Result, $SearchValue)<br />
If $Result > 0 Then ExitLoop<br />
If $Read < $BufferSize Then<br />
_WinAPI_CloseHandle($hFile)<br />
Return -1<br />
EndIf<br />
$Pos += $Read<br />
<br />
WEnd<br />
_WinAPI_CloseHandle($hFile)<br />
If Not $Result Then Return SetError(7, @error, 0)<br />
$Result = $Pos + $Result - 1<br />
Return $Result<br />
EndFunc; ==> _HexSearch<br />
</syntaxhighlight><br />
<br />
[[#top | ReturnToContents]]<br />
<br />
== _FileOpenDialog ==<br />
<br />
{{Snippet Header<br />
| AuthorURL = 35302-guinness<br />
| AuthorName = guinness<br />
}}<br />
<br />
<syntaxhighlight lang="autoit"><br />
Local $sFilePath = _FileOpenDialog("", "", "Images (*.jpg;*.bmp)|Videos (*.avi;*.mpg)", Random(1, @DesktopWidth, 1), Random(1, @DesktopHeight, 1), 1 + 4, "")<br />
<br />
ConsoleWrite('File = ' & $sFilePath & ', @error = ' & @error & @CRLF)<br />
<br />
; #FUNCTION# ====================================================================================================================<br />
; Name ..........: _FileOpenDialog<br />
; Description ...: Initiates a Open File Dialog with the option to set the position of the GUI.<br />
; Syntax ........: _FileOpenDialog($sTitle, $sIntitialDirectory, $sFilter[, $iLeft = -1[, $iTop = -1[, $iOptions = 0[,<br />
; $sDefaultName = ""]]]])<br />
; Parameters ....: $sTitle - Title text of the Dialog GUI.<br />
; $sIntitialDirectory - Initial directory selected in the GUI file tree.<br />
; $sFilter - File type single filter such as "All (*.*)" or "Text files (*.txt)".<br />
; $iLeft - [optional] The left side of the dialog box. By default (-1), the window is centered.<br />
; $iTop - [optional] The top of the dialog box. Default (-1) is centered<br />
; $iOptions - [optional] Dialog Options: To use more than one option, add the required values together. See FileOpenDialog. Default is 0.<br />
; $sDefaultName - [optional] Suggested file name for the user to open. Default is blank ("").<br />
; Return values .: Success: Returns the full path of the file(s) chosen. Results for multiple selections are "Directory|file1|file2|..."<br />
; Failure: Sets @error to non-zero.<br />
; Author ........: guinness<br />
; Remarks........: This doesn't change the working directory of the script like FileOpenDialog does.<br />
; Example .......: Yes<br />
; ===============================================================================================================================<br />
Func _FileOpenDialog($sTitle, $sIntitialDirectory, $sFilter, $iLeft = -1, $iTop = -1, $iOptions = 0, $sDefaultName = "")<br />
Local $hGUI = GUICreate('', -1, -1, $iLeft, $iTop), $sWorkingDir = @WorkingDir<br />
Local $sFilePath = FileOpenDialog($sTitle, $sIntitialDirectory, $sFilter, $iOptions, $sDefaultName, $hGUI)<br />
Local $iError = @error<br />
FileChangeDir($sWorkingDir)<br />
Return SetError($iError, GUIDelete($hGUI), $sFilePath)<br />
EndFunc ;==>_FileOpenDialog()<br />
</syntaxhighlight><br />
<br />
[[#top | ReturnToContents]]<br />
<br />
== _FileRename ==<br />
<br />
{{Snippet Header<br />
| AuthorURL = 52374-johnone<br />
| AuthorName = JohnOne<br />
}}<br />
<br />
<syntaxhighlight lang="autoit"><br />
;### Rename a file ###<br />
;$sFile = Full path to file<br />
;$sRename = New Filename<br />
;$iOverWrite = 0 or 1<br />
<br />
;Success returns 1<br />
;failure, returns 0 and sets @error<br />
; 1 if FileMove fails, <br />
; 2 if $sFile does not exist<br />
;@extended<br />
; 0 if the new file does not already exist / existed<br />
; 1 if the new file already exists / existed<br />
<br />
;#### Example ####<br />
$File = @ScriptDir & '\filetorename.txt'<br />
FileWrite($File, 'Test')<br />
_FileRename($File, 'newname.txt')<br />
If @error Then MsgBox(0, "Error", @error)<br />
<br />
Func _FileRename($sFile, $sRename, $iOverWrite = 0)<br />
Local Const $FILENOTEXIST = 2<br />
If Not FileExists($sFile) Then Return SetError($FILENOTEXIST, 0, 0)<br />
Local $_StringLen = StringLen($sFile)<br />
Local $_StringInStr = StringInStr($sFile, "\", 0, -1, $_StringLen)<br />
Local $_Count = $_StringLen - $_StringInStr<br />
Local $_Dir = StringLeft($sFile, $_StringInStr)<br />
Local $_NewFile = $_Dir & $sRename<br />
Local $_NewFileExists = FileExists($_NewFile)<br />
Local $_FileMove = FileMove($sFile, $_NewFile, $iOverWrite)<br />
Return SetError(Not $_FileMove, $_NewFileExists, $_FileMove)<br />
EndFunc ;==>_FileRename<br />
</syntaxhighlight><br />
<br />
== _FileRename Alternative ==<br />
<br />
<syntaxhighlight lang="autoit"><br />
<br />
;FileRename(PathFile, RenameFile)<br />
;JohnOne<br />
<br />
FileRename(@ScriptDir & "\rename.txt", @ScriptDir & "\renamed.txt")<br />
<br />
Func FileRename($FileName, $ReName)<br />
<br />
Local $SHFILEOPSTRUCT, $SourceStruct, $DestStruct<br />
Local Const $FO_RENAME = 0x0004<br />
Local Const $FOF_SILENT = 0x0004<br />
Local Const $FOF_NOCONFIRMATION = 0x0010<br />
Local Const $FOF_NOERRORUI = 0x0400<br />
Local Const $FOF_NOCONFIRMMKDIR = 0x0200<br />
Local Const $NULL = 0<br />
<br />
$SourceStruct = _StringToStruct($FileName)<br />
$DestStruct = _StringToStruct($ReName)<br />
<br />
$SHFILEOPSTRUCT = DllStructCreate("hwnd hWnd;uint wFunc;ptr pFrom;ptr pTo;int fFlags;int fAnyOperationsAborted;ptr hNameMappings;ptr lpszProgressTitle")<br />
<br />
DllStructSetData($SHFILEOPSTRUCT, "hWnd", $NULL)<br />
DllStructSetData($SHFILEOPSTRUCT, "wFunc", $FO_RENAME)<br />
DllStructSetData($SHFILEOPSTRUCT, "pFrom", DllStructGetPtr($SourceStruct))<br />
DllStructSetData($SHFILEOPSTRUCT, "pTo", DllStructGetPtr($DestStruct))<br />
DllStructSetData($SHFILEOPSTRUCT, "fFlags", BitOR($FOF_SILENT, $FOF_NOCONFIRMATION, $FOF_NOERRORUI, $FOF_NOCONFIRMMKDIR))<br />
DllStructSetData($SHFILEOPSTRUCT, "fAnyOperationsAborted", $NULL)<br />
DllStructSetData($SHFILEOPSTRUCT, "hNameMappings", $NULL)<br />
DllStructSetData($SHFILEOPSTRUCT, "lpszProgressTitle", $NULL)<br />
<br />
$acall = DllCall("shell32.dll", "int", "SHFileOperation", "ptr", DllStructGetPtr($SHFILEOPSTRUCT))<br />
If @error Then<br />
Return SetError(@error, @extended, 0)<br />
EndIf<br />
Return 1<br />
EndFunc ;==>FileRename<br />
<br />
Func _StringToStruct($string)<br />
<br />
Local $iLen = StringLen($string)<br />
Local $Struct = DllStructCreate("char[" & String($iLen + 2) & "]")<br />
DllStructSetData($Struct, 1, $string)<br />
DllStructSetData($Struct, 1, 0, $iLen + 1)<br />
DllStructSetData($Struct, 1, 0, $iLen + 2)<br />
<br />
Return $Struct<br />
EndFunc ;==>_StringToStruct<br />
<br />
</syntaxhighlight><br />
<br />
[[#top | ReturnToContents]]<br />
<br />
== _GetFolderDepth ==<br />
<br />
{{Snippet Header<br />
| AuthorURL = 35302-guinness<br />
| AuthorName = guinness<br />
}}<br />
<br />
<syntaxhighlight lang="autoit"><br />
; Autoit 3.3.5.4 and Below<br />
ConsoleWrite(_GetFolderDepth(@ScriptDir & '') & @CRLF)<br />
ConsoleWrite(_GetFolderDepth(@ScriptDir) & @CRLF)<br />
ConsoleWrite(_GetFolderDepth(@ScriptFullPath) & @CRLF)<br />
<br />
; Get the folder depth of a filepath.<br />
Func _GetFolderDepth($sFilePath)<br />
If StringInStr($sFilePath, '.', 2, -1) Then<br />
$sFilePath = StringLeft($sFilePath, StringInStr($sFilePath, "", 2, -1) - 1)<br />
EndIf<br />
Local $aArray = StringSplit(StringRegExpReplace($sFilePath, '[/]+z', ''), '')<br />
Return $aArray[0] - 1<br />
EndFunc ;==>_GetFolderDepth<br />
</syntaxhighlight><br />
<br />
[[#top | ReturnToContents]]<br />
<br />
== _GetFolderDepth ==<br />
<br />
{{Snippet Header<br />
| AuthorURL = 35302-guinness<br />
| AuthorName = guinness<br />
}}<br />
<br />
<syntaxhighlight lang="autoit"><br />
; Autoit 3.3.5.4 and Above<br />
ConsoleWrite(_GetFolderDepth(@ScriptDir & '') & @CRLF)<br />
ConsoleWrite(_GetFolderDepth(@ScriptDir) & @CRLF)<br />
ConsoleWrite(_GetFolderDepth(@ScriptFullPath) & @CRLF)<br />
<br />
; Get the folder depth of a filepath. Works with V3.3.5.4+<br />
Func _GetFolderDepth($sFilePath)<br />
If StringInStr($sFilePath, '.', 2, -1) Then<br />
$sFilePath = StringLeft($sFilePath, StringInStr($sFilePath, "", 2, -1) - 1)<br />
EndIf<br />
Return StringSplit(StringRegExpReplace($sFilePath, '[/]+z', ''), '')[0] - 1<br />
EndFunc ;==>_GetFolderDepth<br />
</syntaxhighlight><br />
<br />
[[#top | ReturnToContents]]<br />
<br />
== _IsDir ==<br />
<br />
{{Snippet Header<br />
| AuthorURL = 35302-guinness<br />
| AuthorName = guinness<br />
}}<br />
<br />
<syntaxhighlight lang="autoit"><br />
ConsoleWrite("IsDir: Using a file - " & IsDir(@ScriptFullPath) & @CRLF) ; Return 0<br />
ConsoleWrite("IsDir: Using a directory - " & IsDir(@ScriptDir) & @CRLF) ; Return 1<br />
<br />
Func IsDir($sFilePath)<br />
Return Int(FileExists($sFilePath) And StringInStr(FileGetAttrib($sFilePath), 'D', Default, 1) > 0)<br />
EndFunc ;==>IsDir<br />
</syntaxhighlight><br />
<br />
[[#top | ReturnToContents]]<br />
<br />
== _IsFile ==<br />
<br />
{{Snippet Header<br />
| AuthorURL = 35302-guinness<br />
| AuthorName = guinness<br />
}}<br />
<br />
<syntaxhighlight lang="autoit"><br />
ConsoleWrite('IsFile: Using a file - ' & IsFile(@ScriptFullPath) & @CRLF) ; Return 1<br />
ConsoleWrite('IsFile: Using a directory - ' & IsFile(@ScriptDir) & @CRLF) ; Return 0<br />
<br />
Func IsFile($sFilePath)<br />
Return Int(FileExists($sFilePath) And StringInStr(FileGetAttrib($sFilePath), 'D', Default, 1) = 0)<br />
EndFunc ;==>IsFilee<br />
</syntaxhighlight><br />
<br />
[[#top | ReturnToContents]]<br />
<br />
== _IsFileDiff ==<br />
<br />
{{Snippet Header<br />
| AuthorURL = 35302-guinness<br />
| AuthorName = guinness<br />
}}<br />
<br />
<syntaxhighlight lang="autoit"><br />
ConsoleWrite(_IsFileDiff(@ScriptFullPath, @ScriptFullPath) & @CRLF) ; This will return False as the files are exactly the same.<br />
ConsoleWrite(_IsFileDiff(@ScriptFullPath, @AutoItExe) & @CRLF) ; This will return True as the files are different.<br />
<br />
; Check if a file is different.<br />
Func _IsFileDiff($sFilePath_1, $sFilePath_2)<br />
Return RunWait(@ComSpec & ' /c FC /B /W "' & $sFilePath_1 & '" "' & $sFilePath_2 & '"', @WorkingDir, @SW_HIDE) > 0<br />
EndFunc ;==>_IsFileDiff<br />
</syntaxhighlight><br />
<br />
[[#top | ReturnToContents]]<br />
<br />
== _IsFileOlder ==<br />
<br />
{{Snippet Header<br />
| AuthorURL = 35302-guinness<br />
| AuthorName = guinness<br />
}}<br />
<br />
<syntaxhighlight lang="autoit"><br />
#include <Date.au3> ; Required for _DateDiff()<br />
#include <MsgBoxConstants.au3><br />
#include <MsgBoxConstants.au3><br />
<br />
; Check if the current script is older than 10 days.<br />
If _IsFileOlder(@ScriptFullPath, 10) Then<br />
MsgBox($MB_SYSTEMMODAL, '', 'File is older than 10 days.')<br />
Else<br />
MsgBox($MB_SYSTEMMODAL, '', 'File isn''t older than 10 days.')<br />
EndIf<br />
<br />
; Is a file older than a certain number of days.<br />
Func _IsFileOlder($sFilePath, $iDays)<br />
Local $aArray = FileGetTime($sFilePath, $FT_CREATED)<br />
Return _DateDiff('D', $aArray[0] & '/' & $aArray[1] & '/' & $aArray[2] & ' ' & $aArray[3] & ':' & $aArray[4] & ':' & $aArray[5], @YEAR & '/' & @MON & '/' & @MDAY & ' ' & @HOUR & ':' & @MIN & ':' & @SEC) >= $iDays<br />
EndFunc ;==>_IsFileOlder<br />
</syntaxhighlight><br />
<br />
[[#top | ReturnToContents]]<br />
<br />
== _IsFileSame ==<br />
<br />
{{Snippet Header<br />
| AuthorURL = 35302-guinness<br />
| AuthorName = guinness<br />
}}<br />
<br />
<syntaxhighlight lang="autoit"><br />
ConsoleWrite(_IsFileSame(@ScriptFullPath, @ScriptFullPath) & @CRLF) ; This will return True as the files are exactly the same.<br />
ConsoleWrite(_IsFileSame(@ScriptFullPath, @AutoItExe) & @CRLF) ; This will return False as the files are different.<br />
<br />
; Check if a file is the same.<br />
Func _IsFileSame($sFilePath_1, $sFilePath_2)<br />
Return RunWait(@ComSpec & ' /c FC /B /W "' & $sFilePath_1 & '" "' & $sFilePath_2 & '"', @WorkingDir, @SW_HIDE) = 0<br />
EndFunc ;==>_IsFileSame<br />
</syntaxhighlight><br />
<br />
[[#top | ReturnToContents]]<br />
<br />
== _IniReadFile ==<br />
<br />
{{Snippet Header<br />
| AuthorURL = 35302-guinness<br />
| AuthorName = guinness<br />
}}<br />
<br />
<syntaxhighlight lang="autoit"><br />
#include <Array.au3><br />
<br />
__INIFileFill(@ScriptDir & '\Example.ini') ; Create an INI file with random data.<br />
<br />
Local $aArray = _IniReadFile(@ScriptDir & '\Example.ini')<br />
FileDelete(@ScriptDir & '\Example.ini')<br />
_ArrayDisplay($aArray)<br />
<br />
Func _IniReadFile($sFilePath)<br />
Local $aReturn[1][3] = [[0, 3]], $aSectionArray, $aSectionNameArray, $iCount = 0<br />
$aSectionNameArray = IniReadSectionNames($sFilePath)<br />
If @error Then<br />
Return SetError(1, 0, $aReturn)<br />
EndIf<br />
For $A = 1 To $aSectionNameArray[0]<br />
$aSectionArray = IniReadSection($sFilePath, $aSectionNameArray[$A])<br />
If @error Then<br />
ContinueLoop<br />
EndIf<br />
For $B = 1 To $aSectionArray[0][0]<br />
$aReturn[0][0] += 1<br />
$iCount += 1<br />
If $aReturn[0][0] <= $iCount + 1 Then<br />
ReDim $aReturn[$aReturn[0][0] * 2][$aReturn[0][1]]<br />
EndIf<br />
$aReturn[$iCount][0] = $aSectionArray[$B][0]<br />
$aReturn[$iCount][1] = $aSectionArray[$B][1]<br />
$aReturn[$iCount][2] = $aSectionNameArray[$A]<br />
Next<br />
Next<br />
ReDim $aReturn[$aReturn[0][0] + 1][$aReturn[0][1]] ; Remove empty entries.<br />
Return $aReturn<br />
EndFunc ;==>_IniReadFile<br />
<br />
Func __INIFileFill($sFilePath)<br />
Local $sData = '', $sHeader = ''<br />
<br />
For $i = 1 To Random(1, 5, 1)<br />
$sHeader = _RandomText(Random(5, 25, 1))<br />
$sData = ""<br />
For $j = 1 To Random(1, 25, 1)<br />
$sData &= _RandomText(Random(5, 25, 1)) & '=' & _RandomText(Random(5, 25, 1)) & @LF<br />
Next<br />
IniWriteSection($sFilePath, $sHeader, $sData)<br />
Next<br />
EndFunc ;==>__FillINIFile<br />
<br />
Func _RandomText($iLength = 10)<br />
Local $sData = '', $sRandom = ''<br />
For $i = 1 To $iLength<br />
$sRandom = Random(55, 116, 1)<br />
$sData &= Chr($sRandom + 6 * ($sRandom > 90) - 7 * ($sRandom < 65))<br />
Next<br />
Return $sData<br />
EndFunc ;==>_RandomText<br />
</syntaxhighlight><br />
<br />
[[#top | ReturnToContents]]<br />
<br />
== _IniReadInit ==<br />
<br />
{{Snippet Header<br />
| AuthorURL = 9370-mlowery<br />
| AuthorName = mlowery<br />
}}<br />
<br />
<syntaxhighlight lang="autoit"><br />
;===============================================================================<br />
; Description: Reads values from INI or creates INI with initial values.<br />
; Intended to ensure all available INI settings are exposed<br />
; and editable.<br />
; Parameters are identical to IniRead()<br />
; Parameter(s): $filename = filename of INI<br />
; $section = section name of INI<br />
; $key = key name in section<br />
; $default = default value (written to INI if not exists)<br />
; Requirement(s): None<br />
; Return Value(s): Returns value from INI (or default if not defined)<br />
; Note(s): Chr(127) used to detect non-existing value since won't normally exist in a text file<br />
;===============================================================================<br />
Func _IniReadInit($filename, $section, $key, $default)<br />
Local $value = IniRead($filename, $section, $key, Chr(127))<br />
If $value = Chr(127) Then<br />
IniWrite($filename, $section, $key, $default)<br />
$value = $default<br />
EndIf<br />
Return $value<br />
EndFunc<br />
</syntaxhighlight><br />
<br />
[[#top | ReturnToContents]]<br />
<br />
== _IsValidFileType ==<br />
<br />
{{Snippet Header<br />
| AuthorURL = 35302-guinness<br />
| AuthorName = guinness<br />
}}<br />
<br />
<syntaxhighlight lang="autoit"><br />
ConsoleWrite(@ScriptFullPath & " >> " & _IsValidFileType(@ScriptFullPath, "bat;cmd;au3") & @CRLF)<br />
ConsoleWrite(@AutoItExe & " >> " & _IsValidFileType(@AutoItExe, "bat;cmd;au3") & @CRLF)<br />
<br />
; Check if a filepath matches an extension filetype. Based on the idea by guinness - http://www.autoitscript.com/forum/topic/123674-isvalidfiletype/<br />
Func _IsValidFileType($sFilePath, $sList = "bat;cmd;exe") ; By AZJIO - http://www.autoitscript.com/forum/topic/...filetype/page__view__findpost_<br />
Local $iDot = StringInStr($sFilePath, ".", 0, -1)<br />
Return $iDot And StringInStr(';' & $sList & ';', ';' & StringTrimLeft($sFilePath, $iDot) & ';') > 0<br />
EndFunc ;==>_IsValidFileType<br />
</syntaxhighlight><br />
<br />
<syntaxhighlight lang="autoit"><br />
; Example 2<br />
<br />
#include <WinAPIEx.au3><br />
<br />
ConsoleWrite(@ScriptFullPath & " >> " & _IsValidFileType(@ScriptFullPath, "bat;cmd;au3") & @CRLF)<br />
ConsoleWrite(@AutoItExe & " >> " & _IsValidFileType(@AutoItExe, "bat;cmd;au3") & @CRLF)<br />
<br />
; Check if a filepath matches an extension filetype. Based on the idea by guinness - http://www.autoitscript.com/forum/topic/123674-isvalidfiletype/<br />
Func _IsValidFileType($sFilePath, $sList = "bat;cmd;exe", $iOpFast = 1) ; By Yashied.<br />
If StringStripWS($sList, 8) = "" Then<br />
$sList = "*"<br />
EndIf<br />
Return _WinAPI_PathMatchSpec($sFilePath, StringReplace(';' & $sList, ';', ';*.', 0, $iOpFast * 2))<br />
EndFunc ;==>_IsValidFileType<br />
</syntaxhighlight><br />
<br />
[[#top | ReturnToContents]]<br />
<br />
== File Open/Save/Folder Dialog Box ==<br />
<br />
{{Snippet Header<br />
| AuthorURL = 2709-mhz<br />
| AuthorName = MHz<br />
| AuthorURL2 = 4997-odklizec<br />
| AuthorName2 = odklizec<br />
| AuthorURL3 = 6756-danny35d<br />
| AuthorName3 = Danny35d<br />
}}<br />
<br />
<syntaxhighlight lang="autoit"><br />
; Center - File Open/Save/Folder Dialog Box<br />
; Author - odklizec, MHz, Danny35d<br />
<br />
If StringInStr($cmdlineraw, '/MoveWin') Then<br />
Local $size, $PosX, $PosY<br />
$cmdlineraw = StringSplit(StringMid($cmdlineraw, StringInStr($cmdlineraw, '/MoveWin')), ':')<br />
While 1<br />
Select<br />
Case WinExists($cmdlineraw[2])<br />
$size=WinGetPos ($cmdlineraw[2])<br />
$PosX=@DesktopWidth/2 - $size[2]/2<br />
$PosY=@DesktopHeight/2 - $size[3]/2<br />
WinMove($cmdlineraw[2], "", $PosX, $PosY)<br />
WinActivate($cmdlineraw[2])<br />
ExitLoop<br />
EndSelect<br />
Sleep(50)<br />
WEnd<br />
Exit<br />
EndIf<br />
Global $PID, $Read_File, $Save_File<br />
$PID = _FindBrowseWin('Open file Dialog Box')<br />
$Read_File = FileOpenDialog ( "Open file Dialog Box", @ScriptDir & "\", "AutoIt Files (*.au3)",3,@ScriptFullPath)<br />
ProcessClose($PID)<br />
$PID = _FindBrowseWin('Save file Dialog Box')<br />
$Save_File = FileSaveDialog( "Save file Dialog Box", @ScriptDir, "Scripts (*.aut;*.au3)", 3)<br />
ProcessClose($PID)<br />
$PID = _FindBrowseWin('Browse for Folder')<br />
FileSelectFolder("Choose a folder with plugins..", "","4","c:\")<br />
ProcessClose($PID)<br />
<br />
Func _FindBrowseWin($sTitle)<br />
If @Compiled Then<br />
Return(Run(@ScriptFullPath & ' /MoveWin:' & $sTitle))<br />
Else<br />
Return(Run(@AutoItExe & ' "' & @ScriptFullPath & '" /MoveWin:' & $sTitle))<br />
EndIf<br />
EndFunc<br />
</syntaxhighlight><br />
<br />
[[#top | ReturnToContents]]<br />
<br />
== _MoveFileOnReboot ==<br />
<br />
{{Snippet Header<br />
| AuthorURL = 44525-jscript<br />
| AuthorName = JScript<br />
}}<br />
<br />
<syntaxhighlight lang="autoit"><br />
;Author: JScript - Snippet Version No. = 1.0<br />
;Snippet was Created Using AutoIt Version = 3.3.2.0, Creation Date = 21/03/12.<br />
<br />
; Function to Move or Delete a file on next reboot!<br />
Func _MoveFileOnReboot($sSourcePath, $sDestPath = ""); If $sDestPath = "" the file is deleted instead of moved.<br />
Local $iRet<br />
<br />
; PendingFileRenameOperations (HKLM\SYSTEM\CurrentControlSet\Control\Session Manager)<br />
If $DestPath = "" Then<br />
$iRet = DllCall("kernel32.dll", "int", "MoveFileExA", "str", $sSourcePath, "int", 0, "dword", 4)<br />
Else<br />
$iRet = DllCall("kernel32.dll", "int", "MoveFileExA", "str", $sSourcePath, "str", $sDestPath, "dword", 4)<br />
EndIf<br />
<br />
Return $iRet<br />
EndFunc ;==>_MoveFileOnReboot<br />
</syntaxhighlight><br />
<br />
[[#top | ReturnToContents]]<br />
<br />
== _MultipleFileOpenDialog ==<br />
<br />
{{Snippet Header<br />
| AuthorURL =<br />
| AuthorName = /dev/null<br />
}}<br />
<br />
<syntaxhighlight lang="autoit"><br />
Local $message = "Hold down Ctrl or Shift to choose multiple files."<br />
<br />
Local $filename = _MultipleFileOpenDialog($message,300,300)<br />
<br />
Local $var = FileOpenDialog($message, @WindowsDir & "\", "Images (*.jpg;*.bmp)", 1 + 4 )<br />
<br />
If @error Then<br />
MsgBox(4096,"","No File(s) chosen")<br />
Else<br />
$var = StringReplace($var, "|", @CRLF)<br />
MsgBox(4096,"","You chose " & $var)<br />
EndIf<br />
<br />
FileDelete($filename)<br />
func _MultipleFileOpenDialog($title,$posx,$posy)<br />
Local $temp = EnvGet("temp")<br />
Local $filename = $temp & "\move_file_open_dialog.au3"<br />
<br />
Local $script = 'Global $title = "' & $title & '"' & @CRLF<br />
$script &= 'Global $pos_x = ' & $posx & @CRLF<br />
$script &= 'Global $pos_y = ' & $posy & @CRLF<br />
$script &= 'AdlibRegister("_Move",10)' & @CRLF<br />
$script &= 'while 1' & @CRLF<br />
$script &= ' sleep(1000)' & @CRLF<br />
$script &= 'wend' & @CRLF<br />
$script &= 'Func _Move()' & @CRLF<br />
$script &= ' if (WinActive($title)) Then' & @CRLF<br />
$script &= ' WinMove($title,"",$pos_x,$pos_y)' & @CRLF<br />
$script &= ' Exit' & @CRLF<br />
$script &= ' EndIf' & @CRLF<br />
$script &= 'EndFunc' & @CRLF<br />
<br />
FileWrite($filename,$script)<br />
;MsgBox(0,"",$script & @CRLF & $filename)<br />
Run(@AutoItExe & " /AutoIt3ExecuteScript " & $filename)<br />
sleep(250)<br />
Return $filename<br />
EndFunc ;==>_MultipleFileOpenDialog()<br />
</syntaxhighlight><br />
<br />
[[#top | ReturnToContents]]<br />
<br />
== _OpenFolder ==<br />
<br />
{{Snippet Header<br />
| AuthorURL = 35302-guinness<br />
| AuthorName = guinness<br />
}}<br />
<br />
<syntaxhighlight lang="autoit"><br />
#cs<br />
These have been declared in Global scope as you may wish to use them elsewhere in your script.<br />
#ce<br />
Global $ALTSTARTUP = 0x1d<br />
Global $APPDATA = 0x1a<br />
Global $BITBUCKET = 0x0a<br />
Global $COMMONALTSTARTUP = 0x1e<br />
Global $COMMONAPPDATA = 0x23<br />
Global $COMMONDESKTOPDIR = 0x19<br />
Global $COMMONFAVORITES = 0x1f<br />
Global $COMMONPROGRAMS = 0x17<br />
Global $COMMONSTARTMENU = 0x16<br />
Global $COMMONSTARTUP = 0x18<br />
Global $CONTROLS = 0x03<br />
Global $COOKIES = 0x21<br />
Global $DESKTOP = 0x00<br />
Global $DESKTOPDIRECTORY = 0x10<br />
Global $DRIVES = 0x11<br />
Global $FAVORITES = 0x06<br />
Global $FONTS = 0x14<br />
Global $HISTORY = 0x22<br />
Global $INTERNETCACHE = 0x20<br />
Global $LOCALAPPDATA = 0x1c<br />
Global $MYPICTURES = 0x27<br />
Global $NETHOOD = 0x13<br />
Global $NETWORK = 0x12<br />
Global $PERSONAL = 0x05<br />
Global $PRINTERS = 0x04<br />
Global $PRINTHOOD = 0x1b<br />
Global $PROFILE = 0x28<br />
Global $PROGRAMFILES = 0x26<br />
Global $PROGRAMFILESx86 = 0x30<br />
Global $PROGRAMS = 0x02<br />
Global $RECENT = 0x08<br />
Global $SENDTO = 0x09<br />
Global $STARTMENU = 0x0b<br />
Global $STARTUP = 0x07<br />
Global $SYSTEM = 0x25<br />
Global $SYSTEMx86 = 0x29<br />
Global $TEMPLATES = 0x15<br />
Global $WINDOWS = 0x24<br />
<br />
ConsoleWrite(_OpenFolder(@ScriptDir) & @CRLF)<br />
ConsoleWrite(_OpenFolder($PRINTERS) & @CRLF)<br />
<br />
; Open a folder or special folder variable, similar to using ShellExecute.<br />
Func _OpenFolder($sFolderPath)<br />
Local $oShell = ObjCreate('shell.application')<br />
If @error Then<br />
Return SetError(1, 0, 0)<br />
EndIf<br />
$oShell.Open($sFolderPath)<br />
Return 1<br />
EndFunc ;==>_OpenFolder<br />
</syntaxhighlight><br />
<br />
[[#top | ReturnToContents]]<br />
<br />
== _PathAppendToFilename ==<br />
<br />
{{Snippet Header<br />
| AuthorURL = 31965-progandy<br />
| AuthorName = ProgAndy<br />
}}<br />
<br />
<syntaxhighlight lang="autoit"><br />
$sOrg = "C:\Some.Folder\some.file.ext"<br />
$sAdd = "_backup"<br />
<br />
$sNew = _PathAppendToFilename($sOrg, $sAdd)<br />
<br />
$sStripped = _PathStripRightFromFilename($sNew, $sAdd)<br />
<br />
MsgBox(0, "", $sOrg & @CRLF & $sAdd & @CRLF & $sNew & @CRLF & $sStripped)<br />
<br />
Func _PathAppendToFilename($sName, $sAppend)<br />
; Author: ProgAndy<br />
If StringRegExp($sAppend, '[\/\\:\?"<>\|\*]') Then Return SetError(1, 0, $sName)<br />
Return StringRegExpReplace($sName, "(\.[^\\/\.]+)$", $sAppend & "\1", 1)<br />
EndFunc<br />
</syntaxhighlight><br />
<br />
[[#top | ReturnToContents]]<br />
<br />
== _PathStripRightFromFilename ==<br />
<br />
{{Snippet Header<br />
| AuthorURL = 31965-progandy<br />
| AuthorName = ProgAndy<br />
}}<br />
<br />
<syntaxhighlight lang="autoit"><br />
Func _PathStripRightFromFilename($sName, $sStrip)<br />
; Author: ProgAndy<br />
If StringRegExp($sStrip, '[\/\\:\?"<>\|\*]') Then Return SetError(1, 0, $sName)<br />
Return StringRegExpReplace($sName, "\Q" & $sStrip & "\E(\.[^\\/\.]+)$", "\1", 1)<br />
EndFunc<br />
</syntaxhighlight><br />
<br />
[[#top | ReturnToContents]]<br />
<br />
== _SelfDelete ==<br />
<br />
{{Snippet Header<br />
| AuthorURL = 2709-mhz<br />
| AuthorName = MHz<br />
}}<br />
<br />
<syntaxhighlight lang="autoit"><br />
; This also removes the directory which the file is in<br />
; Author MHz with the directory delete addition by The Kandie Man<br />
Func _SelfDelete($iDelay = 0)<br />
Local $sCmdFile<br />
FileDelete(@TempDir & "\scratch.bat")<br />
$sCmdFile = 'ping -n ' & $iDelay & '127.0.0.1 > nul' & @CRLF _<br />
& ':loop' & @CRLF _<br />
& 'del "' & @ScriptFullPath & '"' & @CRLF _<br />
& 'if exist "' & @ScriptFullPath & '" goto loop' & @CRLF _<br />
& ':loop2' & @CRLF _<br />
& 'rmdir /q "' & $dirToDelete & '"' & @CRLF _<br />
& 'if exist "' & $dirToDelete & '" goto loop2' & @CRLF _<br />
& 'del ' & @TempDir & '\scratch.bat'<br />
FileWrite(@TempDir & "\scratch.bat", $sCmdFile)<br />
Run(@TempDir & "\scratch.bat", @TempDir, @SW_HIDE)<br />
EndFunc<br />
</syntaxhighlight><br />
<br />
[[#top | ReturnToContents]]<br />
<br />
== _ShellExecuteFileSelectFolder ==<br />
<br />
{{Snippet Header<br />
| AuthorURL = 35302-guinness<br />
| AuthorName = guinness<br />
}}<br />
<br />
<syntaxhighlight lang="autoit"><br />
ConsoleWrite(_ShellExecuteFileSelectFolder('Select a Folder', @HomeDrive) & @CRLF)<br />
<br />
; Shell Execute a selected folder.<br />
Func _ShellExecuteFileSelectFolder($sText, $sRoot, $iFlag = 0, $sInitialDir = '', $hWnd = '')<br />
Local $sFolder = FileSelectFolder($sText, $sRoot, $iFlag, $sInitialDir, $hWnd)<br />
If @error Then<br />
Return SetError(@error, @extended, '')<br />
EndIf<br />
ShellExecute($sFolder)<br />
Return $sFolder<br />
EndFunc ;==>_ShellExecuteFileSelectFolder<br />
</syntaxhighlight><br />
<br />
[[#top | ReturnToContents]]<br />
<br />
== _SuiCide ==<br />
<br />
{{Snippet Header<br />
| AuthorURL = 28010-larrydalooza<br />
| AuthorName = LarryDalooza<br />
}}<br />
<br />
<syntaxhighlight lang="autoit"><br />
; IMPORTANT MAKE A COPY OF SCRIPT BEFORE DELETION<br />
; Deletes the running script<br />
<br />
Func SuiCide()<br />
Local $sFilePath = @TempDir & '\SuiCide.bat'<br />
FileDelete($sFilePath)<br />
FileWrite($sFilePath, 'loop:' & @CRLF & 'del "' & @ScriptFullPath & '"' & @CRLF & _<br />
'ping -n 1 -w 250 zxywqxz_q' & @CRLF & 'if exist "' & @ScriptFullPath & _<br />
'" goto loop' & @CRLF & 'del SuiCide.bat' & @CRLF)<br />
Exit Run($sFilePath, @TempDir, @SW_HIDE)<br />
EndFunc ;==>SuiCide<br />
</syntaxhighlight><br />
<br />
[[#top | ReturnToContents]]<br />
<br />
== _UniqueFilename ==<br />
<br />
{{Snippet Header<br />
| AuthorURL = 35302-guinness<br />
| AuthorName = guinness<br />
}}<br />
<br />
<syntaxhighlight lang="autoit"><br />
<br />
ConsoleWrite(_UniqueFilename(@ScriptDir, '.au3') & @CRLF)<br />
<br />
Func _UniqueFilename($sFilePath, $sExtension)<br />
Local $iRandom = 0, $sUnqiueFileName = ''<br />
<br />
$sExtension = '.' & StringRegExpReplace($sExtension, '\A[\.]+', '')<br />
$sFilePath = StringRegExpReplace($sFilePath, '[\\/]+\z', '') & '\'<br />
While 1<br />
$iRandom = Random(55, 116, 1)<br />
$sUnqiueFileName &= Chr($iRandom + 6 * ($iRandom > 90) - 7 * ($iRandom < 65))<br />
If FileExists($sFilePath & $sUnqiueFileName & $sExtension) = 0 And StringLen($sUnqiueFileName) > 7 Then<br />
ExitLoop<br />
EndIf<br />
WEnd<br />
Return $sFilePath & $sUnqiueFileName & $sExtension<br />
EndFunc ;==>_UniqueFilename<br />
</syntaxhighlight><br />
<br />
[[#top | ReturnToContents]]<br />
<br />
== Windows - Copy With Progress ==<br />
<br />
{{Snippet Header<br />
| AuthorURL = 19-jos<br />
| AuthorName = Jos<br />
}}<br />
<br />
<syntaxhighlight lang="autoit"><br />
; Windows - Copy With Progress<br />
<br />
;~ 4 Do not display a progress dialog box.<br />
;~ 8 Give the file being operated on a new name in a move, copy, or rename operation if a file with the target name already exists.<br />
;~ 16 Respond with "Yes to All" for any dialog box that is displayed.<br />
;~ 64 Preserve undo information, if possible.<br />
;~ 128 Perform the operation on files only if a wildcard file name (*.*) is specified.<br />
;~ 256 Display a progress dialog box but do not show the file names.<br />
;~ 512 Do not confirm the creation of a new directory if the operation requires one to be created.<br />
;~ 1024 Do not display a user interface if an error occurs.<br />
;~ 2048 Version 4.71. Do not copy the security attributes of the file.<br />
;~ 4096 Only operate in the local directory. Don't operate recursively into subdirectories.<br />
;~ 8192 Version 5.0. Do not copy connected files as a group. Only copy the specified files.<br />
<br />
_FileCopy("C:\Installed Apps\Patches\WindowsXP-KB835935-SP2-ENU.exe","C:\temp")<br />
<br />
; to copy a directory the destination directory must exist<br />
<br />
Func _FileCopy($fromFile,$tofile)<br />
Local $FOF_RESPOND_YES = 16<br />
Local $FOF_SIMPLEPROGRESS = 256<br />
$winShell = ObjCreate("shell.application")<br />
$winShell.namespace($tofile).CopyHere($fromFile,$FOF_RESPOND_YES)<br />
EndFunc<br />
</syntaxhighlight><br />
<br />
<br />
<br />
== Windows - Built In Unzip (Windows Shell) ==<br />
<br />
{{Snippet Header<br />
| AuthorName = Nine<br />
}}<br />
<br />
<syntaxhighlight lang="autoit"><br />
#include <Constants.au3><br />
#include <String.au3><br />
<br />
Opt("MustDeclareVars", 1)<br />
<br />
Const $sZipFile = @ScriptDir & "\Test.zip"<br />
Const $sFolder = @ScriptDir & "\Temp"<br />
<br />
DirRemove ($sFolder, $DIR_REMOVE)<br />
UnZip($sZipFile, $sFolder)<br />
If @error Then Exit MsgBox ($MB_SYSTEMMODAL,"","Error unzipping files : " & @error)<br />
<br />
Func UnZip($sZipFile, $sDestFolder)<br />
If Not FileExists($sZipFile) Then Return SetError (1) ; source file does not exists<br />
If Not FileExists($sDestFolder) Then<br />
If Not DirCreate($sDestFolder) Then Return SetError (2) ; unable to create destination<br />
Else<br />
If Not StringInStr(FileGetAttrib($sDestFolder), "D") Then Return SetError (3) ; destination not folder<br />
EndIf<br />
Local $oShell = ObjCreate("shell.application")<br />
Local $oZip = $oShell.NameSpace($sZipFile)<br />
Local $iZipFileCount = $oZip.items.Count<br />
If Not $iZipFileCount Then Return SetError (4) ; zip file empty<br />
For $oFile In $oZip.items<br />
$oShell.NameSpace($sDestFolder).copyhere($ofile)<br />
Next<br />
EndFunc ;==>UnZip<br />
</syntaxhighlight><br />
<br />
<br />
[[#top | ReturnToContents]]</div>Skysnakehttps://www.autoitscript.com/w/index.php?title=Known_issues_with_Microsoft_Office_automation.&diff=14372Known issues with Microsoft Office automation.2020-07-27T11:44:15Z<p>Skysnake: </p>
<hr />
<div>AutoIt provides a powerful integration and manipulation tool for the MS Windows environment and the WinAPI. Some features of Microsoft's Windows and Office products are proprietary and cannot readily be manipulated. Sometimes workarounds are required. It should be noted that some of these issues change over different versions, resulting in "unexplained" errors or unexpected behavior. This pages is dedicated to identifying those issues, provide explanations and list solutions or workarounds.<br />
<br />
Also, please note that since MS Office products function within the Windows environment, the behavior of different components may be mutually interdependent. Simply changing one setting in a specific box, may not have same or desired effect across all platforms and all versions. The uniform use of Windows 10 should reduce these issues.<br />
<br />
== Microsoft Outlook Email WINMAIL.DAT ==<br />
<br />
=== The Problem ===<br />
<br />
''Microsoft mail products such as Outlook, Office 365 and Exchange may send mail messages in a proprietary format known as TNEF that only other Microsoft products accept. Find out how to configure your Microsoft product in the list below so it doesn’t send messages in the TNEF format.''<br />
From [https://capsulecrm.com/support/microsoft-tnef/ Capsule CRM]<br />
<br />
Email sent using Outlook may be formatted using the Microsoft proprietary TNEF format. Sending the mail appears correct, but the recipient typically receives an email attachment in winmail.dat format. A quick search will indicate just how wide spread this problem is.<br />
<br />
=== The Cause ===<br />
<br />
Transport Neutral Encapsulation Format or TNEF is a proprietary email attachment format used by Microsoft Outlook and Microsoft Exchange Server. An attached file with TNEF encoding is most often named winmail.dat or win.dat, and has a MIME type of Application/MS-TNEF. The official (IANA) media type, however, is application/vnd.ms-tnef.<br />
Fronm this page: [https://en.wikipedia.org/wiki/Transport_Neutral_Encapsulation_Format Wikipedia.org Transport Neutral Encapsulation Format]<br />
<br />
==== Look out for ====<br />
<br />
Microsoft uses "aliases" for the TNEF model.<br />
These include "Sending in Rich Text Format". The mail is not sent in RTF but rather forces TNEF encoding.<br />
Sending in Plain or HTML format appears to prefer non-TNEF, but sometimes fails.<br />
<br />
=== Solutions ===<br />
<br />
Microsoft does not provide a single "Do not use TNEF" configuration item. Settings are dispersed over several interfaces.<br />
<br />
The preferred solution appears to prevent MS Outlook from sending TNEF encoded messages. There is no control over the decoding of the message as received. By preventing the senders use of TNEF, this problem may be mitigated.<br />
<br />
Search '''DisableTNEF''' for alternatives.<br />
<br />
==== Windows Registry ====<br />
<br />
''I added a DWORD named "DisableTNEF" to the key HKEY_CURRENT_USER\Software\Microsoft\Office\16.0\Outlook\Preferences. I set the value at 1.''<br />
From [https://answers.microsoft.com/en-us/msoffice/forum/all/outlook-2016-winmaildat-problem-have-tried-all/f9f15b95-7fdc-4f1c-a1d9-047358747ef8 Microsoft Answers]<br />
<br />
NOTE: Using the '''reg command line tool /f switch''' it is possible to silently add a non-existing value.<br />
<br />
C:\AutoIt>'''reg add HKEY_CURRENT_USER\Software\Microsoft\Office\7.0\Outlook\Preferences /v DisableTNEF /t REG_DWORD /d 1 /f'''<br />
<br />
The operation completed successfully.<br />
<br />
==== In Outlook 2016 ====<br />
If you send emails via Office 365 when using Outlook 2016, refer to the Office 365 configuration.<br />
<br />
Alternatively if you send messages from Outlook 2016 via a different mail server or want a solution that avoids configuration of Office 365, follow these steps to turn off TNEF:<br />
* Click the File tab, click Options, and then click on Mail.<br />
* In the Compose in this message format list, click Plain Text or HTML, and then click OK.<br />
Also clear any preferences associated with Outlook’s auto complete list.<br />
* Go to File Options Mail Send Messages section.<br />
* Click Empty Auto-Complete List.<br />
<br />
==== In Outlook 2013 & 2010 ====<br />
To turn off TNEF, follow these steps:<br />
* Click the File tab, click Options, and then click Mail.<br />
* In the Compose in this message format list, click Plain Text or HTML, and then click OK.<br />
<br />
==== In Outlook 2007 ====<br />
To turn off TNEF, follow these steps:<br />
* On the Tools menu, click Options and then click the Mail Format tab.<br />
* In the Compose in this message format list, click Plain Text or HTML, and then click OK.</div>Skysnakehttps://www.autoitscript.com/w/index.php?title=Known_issues_with_Microsoft_Office_automation.&diff=14296Known issues with Microsoft Office automation.2020-04-21T09:48:40Z<p>Skysnake: /* Windows Registry */</p>
<hr />
<div>AutoIt provides a powerful integration and manipulation tool for the MS Windows environment and the WinAPI. Some features of Microsoft's Windows and Office products are proprietary and cannot readily be manipulated. Sometimes workarounds are required. It should be noted that some of these issues change over different versions, resulting in "unexplained" errors or unexpected behavior. This pages is dedicated to identifying those issues, provide explanations and list solutions or workarounds.<br />
<br />
Also, please note that since MS Office products function within the Windows environment, the behavior of different components may be mutually interdependent. Simply changing one setting in a specific box, may not have same or desired effect across all platforms and all versions. The uniform use of Windows 10 should reduce these issues.<br />
<br />
== Microsoft Outlook Email WINMAIL.DAT ==<br />
<br />
=== The Problem ===<br />
<br />
''Microsoft mail products such as Outlook, Office 365 and Exchange may send mail messages in a proprietary format known as TNEF that only other Microsoft products accept. Find out how to configure your Microsoft product in the list below so it doesn’t send messages in the TNEF format.''<br />
From [https://capsulecrm.com/support/microsoft-tnef/ Capsule CRM]<br />
<br />
Email sent using Outlook may be formatted using the Microsoft proprietary TNEF format. Sending the mail appears correct, but the recipient typically receives and email attachment in winmail.dat format. A quick search will indicate just how wide spread this problem is.<br />
<br />
=== The Cause ===<br />
<br />
Transport Neutral Encapsulation Format or TNEF is a proprietary email attachment format used by Microsoft Outlook and Microsoft Exchange Server. An attached file with TNEF encoding is most often named winmail.dat or win.dat, and has a MIME type of Application/MS-TNEF. The official (IANA) media type, however, is application/vnd.ms-tnef.<br />
Fronm this page: [https://en.wikipedia.org/wiki/Transport_Neutral_Encapsulation_Format Wikipedia.org Transport Neutral Encapsulation Format]<br />
<br />
==== Look out for ====<br />
<br />
Microsoft uses "aliases" for the TNEF model.<br />
These include "Sending in Rich Text Format". The mail is not sent in RTF but rather forces TNEF encoding.<br />
Sending in Plain or HTML format appears to prefer non-TNEF, but sometimes fails.<br />
<br />
=== Solutions ===<br />
<br />
Microsoft does not provide a single "Do not use TNEF" configuration item. Settings are dispersed over several interfaces.<br />
<br />
The preferred solution appears to prevent MS Outlook from sending TNEF encoded messages. There is no control over the decoding of the message as received. By preventing the Senders use of TNEF, this problem may be mitigated.<br />
<br />
Search '''DisableTNEF''' for alternatives<br />
<br />
==== Windows Registry ====<br />
<br />
''I added a DWORD named "DisableTNEF" to the key HKEY_CURRENT_USER\Software\Microsoft\Office\16.0\Outlook\Preferences. I set the value at 1.''<br />
From [https://answers.microsoft.com/en-us/msoffice/forum/all/outlook-2016-winmaildat-problem-have-tried-all/f9f15b95-7fdc-4f1c-a1d9-047358747ef8 Microsoft Answers]<br />
<br />
NOTE: Using the '''reg command line tool /f switch''' it is possible to silently add a non-existing value.<br />
<br />
C:\AutoIt>'''reg add HKEY_CURRENT_USER\Software\Microsoft\Office\7.0\Preferences /v DisableTNEF /t REG_DWORD /d 1 /f'''<br />
<br />
The operation completed successfully.<br />
<br />
==== In Outlook 2016 ====<br />
If you send emails via Office 365 when using Outlook 2016, refer to the Office 365 configuration.<br />
<br />
Alternatively if you send messages from Outlook 2016 via a different mail server or want a solution that avoids configuration of Office 365, follow these steps to turn off TNEF:<br />
* Click the File tab, click Options, and then click on Mail.<br />
* In the Compose in this message format list, click Plain Text or HTML, and then click OK.<br />
Also clear any preferences associated with Outlook’s auto complete list.<br />
* Go to File Options Mail Send Messages section.<br />
* Click Empty Auto-Complete List<br />
<br />
==== In Outlook 2013 & 2010 ====<br />
To turn off TNEF, follow these steps:<br />
* Click the File tab, click Options, and then click Mail.<br />
* In the Compose in this message format list, click Plain Text or HTML, and then click OK.<br />
<br />
==== In Outlook 2007 ====<br />
To turn off TNEF, follow these steps:<br />
* On the Tools menu, click Options and then click the Mail Format tab.<br />
* In the Compose in this message format list, click Plain Text or HTML, and then click OK</div>Skysnakehttps://www.autoitscript.com/w/index.php?title=Known_issues_with_Microsoft_Office_automation.&diff=14295Known issues with Microsoft Office automation.2020-04-21T09:48:15Z<p>Skysnake: /* Windows Registry */</p>
<hr />
<div>AutoIt provides a powerful integration and manipulation tool for the MS Windows environment and the WinAPI. Some features of Microsoft's Windows and Office products are proprietary and cannot readily be manipulated. Sometimes workarounds are required. It should be noted that some of these issues change over different versions, resulting in "unexplained" errors or unexpected behavior. This pages is dedicated to identifying those issues, provide explanations and list solutions or workarounds.<br />
<br />
Also, please note that since MS Office products function within the Windows environment, the behavior of different components may be mutually interdependent. Simply changing one setting in a specific box, may not have same or desired effect across all platforms and all versions. The uniform use of Windows 10 should reduce these issues.<br />
<br />
== Microsoft Outlook Email WINMAIL.DAT ==<br />
<br />
=== The Problem ===<br />
<br />
''Microsoft mail products such as Outlook, Office 365 and Exchange may send mail messages in a proprietary format known as TNEF that only other Microsoft products accept. Find out how to configure your Microsoft product in the list below so it doesn’t send messages in the TNEF format.''<br />
From [https://capsulecrm.com/support/microsoft-tnef/ Capsule CRM]<br />
<br />
Email sent using Outlook may be formatted using the Microsoft proprietary TNEF format. Sending the mail appears correct, but the recipient typically receives and email attachment in winmail.dat format. A quick search will indicate just how wide spread this problem is.<br />
<br />
=== The Cause ===<br />
<br />
Transport Neutral Encapsulation Format or TNEF is a proprietary email attachment format used by Microsoft Outlook and Microsoft Exchange Server. An attached file with TNEF encoding is most often named winmail.dat or win.dat, and has a MIME type of Application/MS-TNEF. The official (IANA) media type, however, is application/vnd.ms-tnef.<br />
Fronm this page: [https://en.wikipedia.org/wiki/Transport_Neutral_Encapsulation_Format Wikipedia.org Transport Neutral Encapsulation Format]<br />
<br />
==== Look out for ====<br />
<br />
Microsoft uses "aliases" for the TNEF model.<br />
These include "Sending in Rich Text Format". The mail is not sent in RTF but rather forces TNEF encoding.<br />
Sending in Plain or HTML format appears to prefer non-TNEF, but sometimes fails.<br />
<br />
=== Solutions ===<br />
<br />
Microsoft does not provide a single "Do not use TNEF" configuration item. Settings are dispersed over several interfaces.<br />
<br />
The preferred solution appears to prevent MS Outlook from sending TNEF encoded messages. There is no control over the decoding of the message as received. By preventing the Senders use of TNEF, this problem may be mitigated.<br />
<br />
Search '''DisableTNEF''' for alternatives<br />
<br />
==== Windows Registry ====<br />
<br />
''I added a DWORD named "DisableTNEF" to the key HKEY_CURRENT_USER\Software\Microsoft\Office\16.0\Outlook\Preferences. I set the value at 1.''<br />
From [https://answers.microsoft.com/en-us/msoffice/forum/all/outlook-2016-winmaildat-problem-have-tried-all/f9f15b95-7fdc-4f1c-a1d9-047358747ef8 Microsoft Answers]<br />
<br />
NOTE: Using the '''reg command line tool /f switch''' it is possible to add a non-existing value.<br />
<br />
C:\AutoIt>'''reg add HKEY_CURRENT_USER\Software\Microsoft\Office\7.0\Preferences /v DisableTNEF /t REG_DWORD /d 1 /f'''<br />
<br />
The operation completed successfully.<br />
<br />
==== In Outlook 2016 ====<br />
If you send emails via Office 365 when using Outlook 2016, refer to the Office 365 configuration.<br />
<br />
Alternatively if you send messages from Outlook 2016 via a different mail server or want a solution that avoids configuration of Office 365, follow these steps to turn off TNEF:<br />
* Click the File tab, click Options, and then click on Mail.<br />
* In the Compose in this message format list, click Plain Text or HTML, and then click OK.<br />
Also clear any preferences associated with Outlook’s auto complete list.<br />
* Go to File Options Mail Send Messages section.<br />
* Click Empty Auto-Complete List<br />
<br />
==== In Outlook 2013 & 2010 ====<br />
To turn off TNEF, follow these steps:<br />
* Click the File tab, click Options, and then click Mail.<br />
* In the Compose in this message format list, click Plain Text or HTML, and then click OK.<br />
<br />
==== In Outlook 2007 ====<br />
To turn off TNEF, follow these steps:<br />
* On the Tools menu, click Options and then click the Mail Format tab.<br />
* In the Compose in this message format list, click Plain Text or HTML, and then click OK</div>Skysnakehttps://www.autoitscript.com/w/index.php?title=Known_issues_with_Microsoft_Office_automation.&diff=14294Known issues with Microsoft Office automation.2020-04-21T09:48:00Z<p>Skysnake: /* Windows Registry */</p>
<hr />
<div>AutoIt provides a powerful integration and manipulation tool for the MS Windows environment and the WinAPI. Some features of Microsoft's Windows and Office products are proprietary and cannot readily be manipulated. Sometimes workarounds are required. It should be noted that some of these issues change over different versions, resulting in "unexplained" errors or unexpected behavior. This pages is dedicated to identifying those issues, provide explanations and list solutions or workarounds.<br />
<br />
Also, please note that since MS Office products function within the Windows environment, the behavior of different components may be mutually interdependent. Simply changing one setting in a specific box, may not have same or desired effect across all platforms and all versions. The uniform use of Windows 10 should reduce these issues.<br />
<br />
== Microsoft Outlook Email WINMAIL.DAT ==<br />
<br />
=== The Problem ===<br />
<br />
''Microsoft mail products such as Outlook, Office 365 and Exchange may send mail messages in a proprietary format known as TNEF that only other Microsoft products accept. Find out how to configure your Microsoft product in the list below so it doesn’t send messages in the TNEF format.''<br />
From [https://capsulecrm.com/support/microsoft-tnef/ Capsule CRM]<br />
<br />
Email sent using Outlook may be formatted using the Microsoft proprietary TNEF format. Sending the mail appears correct, but the recipient typically receives and email attachment in winmail.dat format. A quick search will indicate just how wide spread this problem is.<br />
<br />
=== The Cause ===<br />
<br />
Transport Neutral Encapsulation Format or TNEF is a proprietary email attachment format used by Microsoft Outlook and Microsoft Exchange Server. An attached file with TNEF encoding is most often named winmail.dat or win.dat, and has a MIME type of Application/MS-TNEF. The official (IANA) media type, however, is application/vnd.ms-tnef.<br />
Fronm this page: [https://en.wikipedia.org/wiki/Transport_Neutral_Encapsulation_Format Wikipedia.org Transport Neutral Encapsulation Format]<br />
<br />
==== Look out for ====<br />
<br />
Microsoft uses "aliases" for the TNEF model.<br />
These include "Sending in Rich Text Format". The mail is not sent in RTF but rather forces TNEF encoding.<br />
Sending in Plain or HTML format appears to prefer non-TNEF, but sometimes fails.<br />
<br />
=== Solutions ===<br />
<br />
Microsoft does not provide a single "Do not use TNEF" configuration item. Settings are dispersed over several interfaces.<br />
<br />
The preferred solution appears to prevent MS Outlook from sending TNEF encoded messages. There is no control over the decoding of the message as received. By preventing the Senders use of TNEF, this problem may be mitigated.<br />
<br />
Search '''DisableTNEF''' for alternatives<br />
<br />
==== Windows Registry ====<br />
<br />
''I added a DWORD named "DisableTNEF" to the key HKEY_CURRENT_USER\Software\Microsoft\Office\16.0\Outlook\Preferences. I set the value at 1.''<br />
From [https://answers.microsoft.com/en-us/msoffice/forum/all/outlook-2016-winmaildat-problem-have-tried-all/f9f15b95-7fdc-4f1c-a1d9-047358747ef8 Microsoft Answers]<br />
<br />
NOTE: Using the '''reg command line tool /f switch''' it is possible to add a non-existing value.<br />
C:\AutoIt>'''reg add HKEY_CURRENT_USER\Software\Microsoft\Office\7.0\Preferences /v DisableTNEF /t REG_DWORD /d 1 /f'''<br />
The operation completed successfully.<br />
<br />
==== In Outlook 2016 ====<br />
If you send emails via Office 365 when using Outlook 2016, refer to the Office 365 configuration.<br />
<br />
Alternatively if you send messages from Outlook 2016 via a different mail server or want a solution that avoids configuration of Office 365, follow these steps to turn off TNEF:<br />
* Click the File tab, click Options, and then click on Mail.<br />
* In the Compose in this message format list, click Plain Text or HTML, and then click OK.<br />
Also clear any preferences associated with Outlook’s auto complete list.<br />
* Go to File Options Mail Send Messages section.<br />
* Click Empty Auto-Complete List<br />
<br />
==== In Outlook 2013 & 2010 ====<br />
To turn off TNEF, follow these steps:<br />
* Click the File tab, click Options, and then click Mail.<br />
* In the Compose in this message format list, click Plain Text or HTML, and then click OK.<br />
<br />
==== In Outlook 2007 ====<br />
To turn off TNEF, follow these steps:<br />
* On the Tools menu, click Options and then click the Mail Format tab.<br />
* In the Compose in this message format list, click Plain Text or HTML, and then click OK</div>Skysnakehttps://www.autoitscript.com/w/index.php?title=Known_issues_with_Microsoft_Office_automation.&diff=14288Known issues with Microsoft Office automation.2020-04-21T08:21:30Z<p>Skysnake: /* Solutions */</p>
<hr />
<div>AutoIt provides a powerful integration and manipulation tool for the MS Windows environment and the WinAPI. Some features of Microsoft's Windows and Office products are proprietary and cannot readily be manipulated. Sometimes workarounds are required. It should be noted that some of these issues change over different versions, resulting in "unexplained" errors or unexpected behavior. This pages is dedicated to identifying those issues, provide explanations and list solutions or workarounds.<br />
<br />
Also, please note that since MS Office products function within the Windows environment, the behavior of different components may be mutually interdependent. Simply changing one setting in a specific box, may not have same or desired effect across all platforms and all versions. The uniform use of Windows 10 should reduce these issues.<br />
<br />
== Microsoft Outlook Email WINMAIL.DAT ==<br />
<br />
=== The Problem ===<br />
<br />
''Microsoft mail products such as Outlook, Office 365 and Exchange may send mail messages in a proprietary format known as TNEF that only other Microsoft products accept. Find out how to configure your Microsoft product in the list below so it doesn’t send messages in the TNEF format.''<br />
From [https://capsulecrm.com/support/microsoft-tnef/ Capsule CRM]<br />
<br />
Email sent using Outlook may be formatted using the Microsoft proprietary TNEF format. Sending the mail appears correct, but the recipient typically receives and email attachment in winmail.dat format. A quick search will indicate just how wide spread this problem is.<br />
<br />
=== The Cause ===<br />
<br />
Transport Neutral Encapsulation Format or TNEF is a proprietary email attachment format used by Microsoft Outlook and Microsoft Exchange Server. An attached file with TNEF encoding is most often named winmail.dat or win.dat, and has a MIME type of Application/MS-TNEF. The official (IANA) media type, however, is application/vnd.ms-tnef.<br />
Fronm this page: [https://en.wikipedia.org/wiki/Transport_Neutral_Encapsulation_Format Wikipedia.org Transport Neutral Encapsulation Format]<br />
<br />
==== Look out for ====<br />
<br />
Microsoft uses "aliases" for the TNEF model.<br />
These include "Sending in Rich Text Format". The mail is not sent in RTF but rather forces TNEF encoding.<br />
Sending in Plain or HTML format appears to prefer non-TNEF, but sometimes fails.<br />
<br />
=== Solutions ===<br />
<br />
Microsoft does not provide a single "Do not use TNEF" configuration item. Settings are dispersed over several interfaces.<br />
<br />
The preferred solution appears to prevent MS Outlook from sending TNEF encoded messages. There is no control over the decoding of the message as received. By preventing the Senders use of TNEF, this problem may be mitigated.<br />
<br />
Search '''DisableTNEF''' for alternatives<br />
<br />
==== Windows Registry ====<br />
<br />
''I added a DWORD named "DisableTNEF" to the key HKEY_CURRENT_USER\Software\Microsoft\Office\16.0\Outlook\Preferences. I set the value at 1.''<br />
From [https://answers.microsoft.com/en-us/msoffice/forum/all/outlook-2016-winmaildat-problem-have-tried-all/f9f15b95-7fdc-4f1c-a1d9-047358747ef8 Microsoft Answers]<br />
<br />
==== In Outlook 2016 ====<br />
If you send emails via Office 365 when using Outlook 2016, refer to the Office 365 configuration.<br />
<br />
Alternatively if you send messages from Outlook 2016 via a different mail server or want a solution that avoids configuration of Office 365, follow these steps to turn off TNEF:<br />
* Click the File tab, click Options, and then click on Mail.<br />
* In the Compose in this message format list, click Plain Text or HTML, and then click OK.<br />
Also clear any preferences associated with Outlook’s auto complete list.<br />
* Go to File Options Mail Send Messages section.<br />
* Click Empty Auto-Complete List<br />
<br />
==== In Outlook 2013 & 2010 ====<br />
To turn off TNEF, follow these steps:<br />
* Click the File tab, click Options, and then click Mail.<br />
* In the Compose in this message format list, click Plain Text or HTML, and then click OK.<br />
<br />
==== In Outlook 2007 ====<br />
To turn off TNEF, follow these steps:<br />
* On the Tools menu, click Options and then click the Mail Format tab.<br />
* In the Compose in this message format list, click Plain Text or HTML, and then click OK</div>Skysnakehttps://www.autoitscript.com/w/index.php?title=Known_issues_with_Microsoft_Office_automation.&diff=14287Known issues with Microsoft Office automation.2020-04-21T08:07:25Z<p>Skysnake: </p>
<hr />
<div>AutoIt provides a powerful integration and manipulation tool for the MS Windows environment and the WinAPI. Some features of Microsoft's Windows and Office products are proprietary and cannot readily be manipulated. Sometimes workarounds are required. It should be noted that some of these issues change over different versions, resulting in "unexplained" errors or unexpected behavior. This pages is dedicated to identifying those issues, provide explanations and list solutions or workarounds.<br />
<br />
Also, please note that since MS Office products function within the Windows environment, the behavior of different components may be mutually interdependent. Simply changing one setting in a specific box, may not have same or desired effect across all platforms and all versions. The uniform use of Windows 10 should reduce these issues.<br />
<br />
== Microsoft Outlook Email WINMAIL.DAT ==<br />
<br />
=== The Problem ===<br />
<br />
''Microsoft mail products such as Outlook, Office 365 and Exchange may send mail messages in a proprietary format known as TNEF that only other Microsoft products accept. Find out how to configure your Microsoft product in the list below so it doesn’t send messages in the TNEF format.''<br />
From [https://capsulecrm.com/support/microsoft-tnef/ Capsule CRM]<br />
<br />
Email sent using Outlook may be formatted using the Microsoft proprietary TNEF format. Sending the mail appears correct, but the recipient typically receives and email attachment in winmail.dat format. A quick search will indicate just how wide spread this problem is.<br />
<br />
=== The Cause ===<br />
<br />
Transport Neutral Encapsulation Format or TNEF is a proprietary email attachment format used by Microsoft Outlook and Microsoft Exchange Server. An attached file with TNEF encoding is most often named winmail.dat or win.dat, and has a MIME type of Application/MS-TNEF. The official (IANA) media type, however, is application/vnd.ms-tnef.<br />
Fronm this page: [https://en.wikipedia.org/wiki/Transport_Neutral_Encapsulation_Format Wikipedia.org Transport Neutral Encapsulation Format]<br />
<br />
==== Look out for ====<br />
<br />
Microsoft uses "aliases" for the TNEF model.<br />
These include "Sending in Rich Text Format". The mail is not sent in RTF but rather forces TNEF encoding.<br />
Sending in Plain or HTML format appears to prefer non-TNEF, but sometimes fails.<br />
<br />
=== Solutions ===<br />
<br />
Microsoft does not provide a single "Do not use TNEF" configuration item. Settings are dispersed over several interfaces.<br />
<br />
The preferred solution appears to prevent MS Outlook from sending TNEF encoded messages. There is no control over the decoding of the message as received. By preventing the Senders use of TNEF, this problem may be mitigated.<br />
<br />
==== Windows Registry ====<br />
<br />
''I added a DWORD named "DisableTNEF" to the key HKEY_CURRENT_USER\Software\Microsoft\Office\16.0\Outlook\Preferences. I set the value at 1.''<br />
From [https://answers.microsoft.com/en-us/msoffice/forum/all/outlook-2016-winmaildat-problem-have-tried-all/f9f15b95-7fdc-4f1c-a1d9-047358747ef8 Microsoft Answers]<br />
<br />
==== In Outlook 2016 ====<br />
If you send emails via Office 365 when using Outlook 2016, refer to the Office 365 configuration.<br />
<br />
Alternatively if you send messages from Outlook 2016 via a different mail server or want a solution that avoids configuration of Office 365, follow these steps to turn off TNEF:<br />
* Click the File tab, click Options, and then click on Mail.<br />
* In the Compose in this message format list, click Plain Text or HTML, and then click OK.<br />
Also clear any preferences associated with Outlook’s auto complete list.<br />
* Go to File Options Mail Send Messages section.<br />
* Click Empty Auto-Complete List<br />
<br />
==== In Outlook 2013 & 2010 ====<br />
To turn off TNEF, follow these steps:<br />
* Click the File tab, click Options, and then click Mail.<br />
* In the Compose in this message format list, click Plain Text or HTML, and then click OK.<br />
<br />
==== In Outlook 2007 ====<br />
To turn off TNEF, follow these steps:<br />
* On the Tools menu, click Options and then click the Mail Format tab.<br />
* In the Compose in this message format list, click Plain Text or HTML, and then click OK</div>Skysnakehttps://www.autoitscript.com/w/index.php?title=Known_issues_with_Microsoft_Office_automation.&diff=14286Known issues with Microsoft Office automation.2020-04-21T08:06:55Z<p>Skysnake: </p>
<hr />
<div>AutoIt provides a powerful integration and manipulation tool for the MS Windows environment and the WinAPI. Some features of Microsoft's Windows and Office products are proprietary and cannot readily be manipulated. Sometimes workarounds are required. It should be noted that some of these issues change over different versions, resulting in "unexplained" errors or unexpected behavior. This pages is dedicated to identifying those issues, provide explanations and list solutions or workarounds.<br />
<br />
Also, please note that since MS Office products function within the Windows environment, the behavior of different components may be mutually interdependent. Simply changing one setting in a specific box, may not have same or desired effect across all platforms and all versions. The uniform use of Windows 10 should reduce these issues.<br />
<br />
== Microsoft Outlook Email WINMAIL.DAT ==<br />
<br />
=== The Problem ===<br />
<br />
''Microsoft mail products such as Outlook, Office 365 and Exchange may send mail messages in a proprietary format known as TNEF that only other Microsoft products accept. Find out how to configure your Microsoft product in the list below so it doesn’t send messages in the TNEF format.''<br />
From [https://capsulecrm.com/support/microsoft-tnef/ Capsule CRM]<br />
<br />
Email sent using Outlook may be formatted using the Microsoft proprietary TNEF format. Sending the mail appears correct, but the recipient typically receives and email attachment in winmail.dat format. A quick search will indicate just how wide spread this problem is.<br />
<br />
=== The Cause ===<br />
<br />
Transport Neutral Encapsulation Format or TNEF is a proprietary email attachment format used by Microsoft Outlook and Microsoft Exchange Server. An attached file with TNEF encoding is most often named winmail.dat or win.dat, and has a MIME type of Application/MS-TNEF. The official (IANA) media type, however, is application/vnd.ms-tnef.<br />
Fronm this page: [https://en.wikipedia.org/wiki/Transport_Neutral_Encapsulation_Format Wikipedia.org Transport Neutral Encapsulation Format]<br />
<br />
==== Look out for ====<br />
<br />
Microsoft uses "aliases" for the TNEF model.<br />
These include "Sending in Rich Text Format". The mail is not sent in RTF but rather forces TNEF encoding.<br />
Sending in Plain or HTML format appears to prefer non-TNEF, but sometimes fails.<br />
<br />
=== Solutions ===<br />
<br />
Microsoft does not provide a single "Do not use TNEF" configuration item. Settings are dispersed over several interfaces.<br />
<br />
The preferred solution appears to prevent MS Outlook from sending TNEF encoded messages. There is no control over the decoding of the message as received. By preventing the Senders use of TNEF, this problem may be mitigated.<br />
<br />
==== Windows Registry ====<br />
<br />
''I added a DWORD named "DisableTNEF" to the key HKEY_CURRENT_USER\Software\Microsoft\Office\16.0\Outlook\Preferences. I set the value at 1.''<br />
From [https://answers.microsoft.com/en-us/msoffice/forum/all/outlook-2016-winmaildat-problem-have-tried-all/f9f15b95-7fdc-4f1c-a1d9-047358747ef8 Microsoft Answers]<br />
<br />
==== In Outlook 2016 ====<br />
If you send emails via Office 365 when using Outlook 2016, refer to the Office 365 configuration.<br />
<br />
Alternatively if you send messages from Outlook 2016 via a different mail server or want a solution that avoids configuration of Office 365, follow these steps to turn off TNEF:<br />
* Click the File tab, click Options, and then click on Mail.<br />
* In the Compose in this message format list, click Plain Text or HTML, and then click OK.<br />
* Also clear any preferences associated with Outlook’s auto complete list.<br />
* Go to File Options Mail Send Messages section.<br />
* Click Empty Auto-Complete List<br />
<br />
==== In Outlook 2013 & 2010 ====<br />
To turn off TNEF, follow these steps:<br />
* Click the File tab, click Options, and then click Mail.<br />
* In the Compose in this message format list, click Plain Text or HTML, and then click OK.<br />
<br />
==== In Outlook 2007 ====<br />
To turn off TNEF, follow these steps:<br />
* On the Tools menu, click Options and then click the Mail Format tab.<br />
* In the Compose in this message format list, click Plain Text or HTML, and then click OK</div>Skysnakehttps://www.autoitscript.com/w/index.php?title=User_Defined_Functions&diff=14285User Defined Functions2020-04-21T08:02:44Z<p>Skysnake: /* Microsoft Office */</p>
<hr />
<div>This page is a listing of libraries of '''user defined functions''' (UDF). These libraries have been written to allow easy integration into your own scripts and are a very valuable resource for any programmer.<br /><br />
This list is probably not complete (337 UDFs on 2020/04/20), but constantly supplemented.<br />
If you do not find a solution here, ask a new question on the [https://www.autoitscript.com/forum/forum/2-general-help-and-support/ forum].<br />
<br />
'''Note:'''<br /><br />
The listed UDFs might have been written for older versions of AutoIt. So there is no guarantee that every UDF works smoothly with newer versions.<br /><br />
None of the UDFs has been tested by the maintainers of this list so you as a user need to make sure that they deliver the expected results.<br /><br />
<br />
<br /><br />
'''Latest modifications'''<br /><br />
{| class="wikitable"<br />
|-<br />
! Date !! section !! creator !! title<br />
|-<br />
| 2020-04-20 || Script Coding/Analyzing/Debugging || MrCreatoR || Highlight AutoIt v3 syntax code to html/bbcode format.<br />
|-<br />
| 2020-03-10 || Encryption and hash || RTFC || Encrypt scripts without placing the key inside the script. <br />
|-<br />
| 2019-12-02 || Encryption and hash || TheXman || Microsoft's long-term replacement for their CryptoAPI.<br />
|-<br />
| 2019-11-18 || Script Coding/Analyzing/Debugging || LarsJ || Create/access/process Variants and SafeArrays.<br />
|-<br />
| 2019-09-29 || Inter Process Communications || tarretarretarre || Autoit-Socket-IO - Networking in AutoIt made simple!.<br />
|-<br />
| 2019-09-03 || Windows || water || TaskScheduler - Brushed up Task Scheduler UDF.<br />
|-<br />
| 2019-05-17 || GUI additions || S3cret91 || Notify - Display permanent desktop notifications.<br />
|-<br />
| 2019-05-17 || Script Coding/Analyzing/Debugging || user4157124 || AutoIt error logger (AUERLO) - File- and stdout (etc.) output of messages, regular- and COM Object errors, exit method and -code, etc.<br />
|-<br />
| 2019-05-10 || GUI additions || NHD || Wi3SMenu - Create a slide menu with Windows 10 style. Supports color, icon and opacity.<br />
|-<br />
| 2019-05-08 || Hardware || RTFC || BuildPartitionTable - Scans a physical drive's partition table and returns a partition_table, allocation_table and volumes_table.<br />
|-<br />
| 2019-05-05 || All sections || water || Changed all links from http to https<br />
|-<br />
| 2019-04-01 || Multiple sections || Ward || Seems Ward left the forum and has removed all UDFs he created :-(<br />
|-<br />
| 2019-03-28 || Files, Databases and web connections || TheXman || jq - A powerful and flexible JSON processor based on jq<br />
|-<br />
| 2019-03-14 || Script Coding/Analyzing/Debugging || Yashied || Log UDF - Allows to create text log files<br />
|-<br />
| 2019-02-25 || Files, Databases and web connections || seangriffin || CSV - Manipulate CSV files<br />
|-<br />
| 2019-02-22 || GUI additions || Taskms4 || MTSkin - Simply create modern looking GUIs (borderless GUI, Interactive menu panel (with mouse-over detection), a bunch of skins)<br />
|-<br />
| 2019-01-27 || Microsoft Office || water || Outlook Tools - Import/export contacts from/to vcf files and calendar events from/to ics files<br />
|}<br />
<br /><br />
<br />
== Automation ==<br />
<br />
===Browsers===<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=154439 Chrome (by seangriffin)] - Automate the most common tasks in Chrome with this UDF.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=95595 Firefox (by Stilgar)] - A little less support for automation than IE, but still very good.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=167661 Firefox (by Danp2)] - Modified newer version of Stilgar Firefox UDF.<br />
* [https://www.autoitscript.com/forum/files/file/224-firefox-profile-backup/ FireFox Profile Backup 1.0 (by careca)] - Backup or restore your firefox profile. The application searches for the profile in home drive that will be the one to backup.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=124330 _FF_AutoLogin (by Stilgar)] - This is a auto-login function and login-function-generator for FireFox and the FF.au3.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=92035 _FF_DM (by Stilgar)] - UDF to control the FireFox Download-Manager (not the download-window).<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=91650 _FF_FoxBox (by Stilgar)] - UDF to control Fox!Box (A Mozilla Firefox extension for the AVM FRITZ!Box) with FF.au3.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=91665 _FF_Screengrab (by Stilgar)] - UDF to control Screengrab! (FireFox-AddOn) with FF.au3.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=124330 _HTML (by Stilgar)] - Get informations from any HTML (XML) source, without any browser.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=166542 HTMLDocumentEvents (by SmOke_N)] - Track IE document events.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=167035 IEEx (by SmOke_N)] - IE extended library with some Javascript options.<br />
* Internet Explorer (by DaleHohm et al.) - IE library that is now supplied with a standard AutoIt install.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=153520 IUIAutomation MS framework (by junkew)] - IUIAutomation MS framework to automate chrome, FF, IE etc.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=149203 NavInfo (by Nessie)] - With this UDF you can check if a specified browser/software is installed and which version is being used.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=61090 Opera (by MrCreatoR,)] - Automate the most common tasks in Opera with this UDF.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=191990 WebDriver (by Danp2)] - W3C compliant Webriver UDF.<br />
<br />
===Microsoft Office===<br />
* [[Known issues with Microsoft Office automation.]]<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=32144 Microsoft Office Access (by randallc)] - Automate Microsoft Access.<br />
* Microsoft Office Excel (by water et al.) - This UDF is included in AutoIt. Link to the [[Excel_UDF|documentation]] pages.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=135312 Microsoft Office Excel Charts (by water, GreenCan)] - Creating charts using Microsoft Excel.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=126305 Microsoft Office Outlook (by water)] - Automate Microsoft Outlook. Link to the [[OutlookEX_UDF_-_General|documentation]] pages.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=480 Outlook Tools (by water)] - Built on top of the OutlookEX UDF it offers some often needed extended functionality (import/export ics/vcf files etc.). Link to the [[OutlookTools|documentation]] pages.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=50254 Microsoft Office PowerPoint (by Toady)] - Automate Microsoft PowerPoint.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=178783 Microsoft Office PowerPoint (by water)] - Automate Microsoft PowerPoint.<br />
* Microsoft Office Word (by water et al.) - This UDF is included in AutoIt. Link to the [[Word_UDF|documentation]] pages.<br />
<br />
===OpenOffice/LibreOffice===<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=151530 OOo/LibO Calc (by GMK)] - OpenOfficeCalc UDF (works also for Libre Office).<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=185932 OpenOffice/LibreOffice Spell Checker (by GMK)] - Function to validate words, and show spell alternatives.<br />
<br />
===Other Applications===<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=106163 Active Directory (by water)] - Extensive library to control and manipulate the Windows active directory. Link to the [[Active_Directory_UDF_-_General|documentation]] pages.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=87956 Java (by seangriffin)] - Creates an access bridge between your application and a Java application. Allowing you to automate some Java applications.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=86574 SAP (by seangriffin)] - SAP business management automation.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=149540 SAPWizard (by ozmike)] - SAPWizard UDF.<br />
<br />
== Script Coding/Analyzing/Debugging ==<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=198929 AutoIt error logger (AUERLO) (by user4157124)] - File- and stdout (etc.) output of messages, regular- and COM Object errors, exit method and -code, etc.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=112879 AutoIt Syntax Highlight (by MrCreatoR)] - Highlights AutoIt v3 syntax code to html/bbcode format.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=454 cDebug (by c.haslam)] - Dumps the values of all AutoIt subtypes and expressions including nested arrays, DLL structs and maps.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=195882 ErrorLog (by mLipok)] - Logs program activities and errors to different output locations.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=156196 Log4a (by zorphnog)] - Logging library loosely based upon the log4j and NLog libaries.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=195862 Loga (by Danyfirex)] - Simple logging library to keep track of code with an integrated console.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=119032 Log UDF (by Yashied)] - This simple UDF allows you to create a text log files.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=200660 Variants and Safearrays (by LarsJ)] - Create/access/process Variants and SafeArrays.<br />
<br />
=== Inter Process Communications ===<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=188991 Autoit-Socket-IO (by tarretarretarre)] - Autoit-Socket-IO is a event driven TCP/IP wrapper heavily inspired from Socket.IO with focus on user friendliness and long term sustainability.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=126936 Container (by MrCreatoR)] - Scripts interaction method. Allows to transfer whole arrays as data, and even COM objects.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=55994 DDEML (by doudou)] - Use your AutoIt script as DDE client or server.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=193277 FMIPC (by argumentum)] - IPC via FileMapping.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=127615 Interprocess (by JScript)] - Remotely execute a function in another script (using Mailslot).<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=193158 IPC_IO (by JohnWIlling)] - IPC library supporting multiple connection types (such as: Named Pipe, File, TCP, SharedMemory, MailSlot).<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=106710 Mailslot (by trancexx)] - IPC using Mailslots.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=169797 Pool - Post Office for Organised Labour (by RTFC)] - Provides multiple AutoIt processes with an infrastructure for exchanging messages, data, and remote-control instructions.<br />
<br />
== Files, Databases and web connections ==<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=180850 ADO (by mLipok)] - A modifed version of the _SQL UDF to access all kind of databases (MSSQL, MySQL, PostgreSQL, SQLite, MS ACCESS, XLS, TXT, and many other which use ADO and ODBC).<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=105875 ADODB (by spudw2k)] - ADODB Example.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=176895 AXML (by Aipion)] - This is a Wrapper for Pugixml, made with C++.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=145142 DBF (by funkey)] - dBase database read and write with DLL.<br />
* [https://www.autoitscript.com/forum/topic/114406-csv-file-to-multidimensional-array/?do=findComment&comment=799820 CSV (by ProgAndy)] - Read/write CSV files to/from 2D arrays.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=197909 CSV (by seangriffin)] - Manipulate CSV files using SQLite.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=119238 Excel file generation UDF (by jerome)] - Excel file generation (multi-sheet workbook) without the need to have Excel installed.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=143866 Excel XML UDF (by FireFox)] - UDF to work with SpreadsheetML (Open XML file formats).<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=155905 EXml (by jdelaney)] - Create Excel file (SpreadsheetML) through "Microsoft.XMLDOM".<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=116072 EzMySql (by Yoriz)] - EzMySql - Use MySQL Databases with AutoIt.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=94920 FireBird (by eltorro)] - FireBird, Interbase DLL UDF.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=104150 JSON (by Gabriel13)] - RFC4627 compliant JSON encode/decode.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=148114 JSON (by Ward)] - JSMN - A Non-Strict JSON UDF.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=156794 JSON (by ozmike)] - Bridge to Native Windows JSON plus OO extension for AutoIt.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=173797 JSONgen: JSON generator (by Jefrey)] - UDF to generate JSON.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=197421 jq (by TheXman)] - A powerful and flexible JSON processor based on jq.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=127101 MS SQL (by TheLuBu)] - MSSQL.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=51952 MS SQL (by ChrisL)] - _SQL. ADODB Connection.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=20814 MySQL (by cdkid)] - MySQL relational database management system UDF.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=85617 MySQL (by ProgAndy)] - MySQL UDFs (without ODBC - working with libmysql.dll).<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=122360 MySQL (by James)] - MySQL ODBC Connector.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=187223 romaSQL (rynow)] - This autoIt UDF is built on the concept of Laravel Query & doctrine. Connection string is based on ADODB / ODBC.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=143331 Sharepoint 2007/2010 UDF (by schoppet)] - UDF to access the SOAP-Webservices of Sharepoint 2007/2010.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=17099 SQLite (by ptrex)] - SQLite is a library that implements a self-contained, embeddable, zero-configuration SQL database engine.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=142977 SQLite Array Functions (by SmOke_N)] - SQLite Array Functions - a faster method for unique arrays and sorting methods.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=140521 SQLite - Database UDF (by PhoenixXL)] - UDF for SQLite so that beginners will also be able to do the stuff.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=157853 SQLiteEx UDF (by 57ar7up)] - SQLiteEx UDF v0.5.1 - Simplest work with SQLite.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=163633 Xbase I/O UDF (by RTFC)] - Transfer data between Xbase Data file (*.dbf) and AutoIt array written in pure AutoIt (no SQL, no ADO, no dlls, no external dependencies).<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=19848 XML DOM Wrapper (by eltorro)] - Supports CRUD operations on XML. Including XSL and XPath.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=176895 XML (by mLipok)] - New version of XML DOM Wrapper, with many new features.<br />
<br />
== Data compression ==<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=121985 AutoIt Machine Code Algorithm Collection (by Ward)] - <s>Checksum, Compression, Encode and hash algorithm collection for 32 and 64 bit.</s> File removed by author.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=85094 7z, zip, gzip, bzip2, tar (by rasim)] - Extensive library that uses a external DLL that must be provided with the script.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=92958 gZip (by Zinthose)] - Based on the parsing of gZip.exe output. It can work with memory, it doesn't work with files. <br />
* [https://www.autoitscript.com/forum/index.php?showtopic=87441 LZMA (by trancexx)] - LZMA (Native Windows).<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=112273 LZMA Compression (by Ward)] - <s>LZMA Compression UDF.</s> File removed by author.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=166634 MessagePack (by Ward)] - <s>Efficient binary serialization format to exchange data among multiple languages like JSON - but faster and smaller.</s> File removed by author.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=138838 Package (by Yashied)] - Package UDF.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=129529 pZip (by asdf8)] - PureZIP_L library UDF.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=76176 UnRAR (by rasim)] - UnRAR.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=17727 XZip (by eltorro)] - Another UDF for "XStandard XZIP Component".<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=161847 XZip (by mLipok)] - UDF for "XStandard XZIP Component".<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=44524 Zip plugin (by eltorro)] - Zip plugin.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=73425 ZIP (by torels)] - ZIP UDF in pure AutoIt.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=116565 zip (by wraithdu)] - Create ZIP files and unpack ZIP files.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=135565 ZIP (by joakim)] - ZIP STRUCTS UDF (from scratch).<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=128962 zLib (by Ward)] - <s>zLib (Deflate/Inflate/GZIP) UDF.</s> File removed by author.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=87284 ZLib (by monoceres)] - Based on ZLib.dll. It can compress/uncompress data in memory, it doesn't work with files.<br />
<br />
== Encryption and hash ==<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=78745 AES Rijndael (by Ward)] - <s>Very fast AES UDF. Supports ECB/CBC/CFB/OFB block cipher mode.</s> File removed by author.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=121985 AutoIt Machine Code Algorithm Collection (by Ward)] - <s>Checksum, Compression, Encode and hash algorithm collection for 32 and 64 bit.</s> File removed by author.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=81332 _Base64Encode, _Base64Decode (by trancexx)] - Fast _Base64Encode, _Base64Decode (calling functions "CryptBinaryToString" and "CryptStringToBinary" in Crypt32.dll).<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=153246 Base91 and Base128 (by Beege)] - Base91 and Base128 functions.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=155538 Codecrypter (by RTFC)] - Encrypt scripts without placing the key inside the script. <br />
* [https://www.autoitscript.com/forum/index.php?showtopic=201002 Cryptography API: Next Gen (by TheXman)] - Microsoft's long-term replacement for their CryptoAPI.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=76976 MD5,SHA1,CRC32,RC4,BASE64,XXTEA (by Ward)] - <s>Several encryption and hash functions.</s> File removed by author.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=107784 TrueCrypt (by FuryCell)] - TrueCrypt UDFs.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=140737 WinTrust (by kasty)] - verify the integrity of a file with its embedded signature or a given catalog.<br />
<br />
== GUI Additions ==<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=97241 3D Pie chart (by WideBoyDixon)] - 3D Pie chart.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=173924 Chart_UDF (by Kanashius)] - This UDF can be used to Display bar charts in a window.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=96258 ContextHelp (by Yashied)] - Management of context help ([https://www.autoitscript.com/forum/index.php?showtopic=72152-contexthelp/ original]).<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=109096 ExtMsgBox (by Melba23)] - A very customisable replacement for MsgBox.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=105582 GUICtrlOnChangeRegister (by Mat)] - Call a function when an edits content is changed.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=145149 GUIExtender (by Melba23)] - Expand and contract sections of your GUI ([https://www.autoitscript.com/forum/index.php?showtopic=117909 original]).<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=119505 GUIFrame (by Melba23 & Kip)] - Divide a GUI into adjustable frames.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=144207 GUI Panel (by FireFox)] - Manage child GUIs as panel ctrls.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=113723 GUI Scrollbars (by Melba23)] - Automatically sized scrollbars with a single command.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=161184 MetroGUI (by BBs19)] - Windows 10 style buttons, toggles, radios etc.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=20967 Modern tray menu (by Holger)] - Allows the creation of modern, fancy GUI and tray menus with icons and colors.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=194693 MTSkin (by Taskms4)] - Simply create modern looking GUIs (borderless GUI, Interactive menu panel (with mouse-over detection), a bunch of skins).<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=182136 Notifications (by S3cret91)] - Display permanent desktop notifications.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=136149 Notify (by Melba23)] - Small notifications on the edge of the display.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=161750 Pie chart (by Andreik)] - Pie chart.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=75429 Real Vista Aero Glass (by James)] - Real Vista Aero Glass UDF - you can apply glass effect to your GUI.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=71811 SetOnEvent (by martin)] - Provides an easy way for an event to call functions with parameters.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=103871 _SysTray (by wraithdu)] - Get info about and manipulate Systray icons.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=108445 Toast (by Melba23)] - Small message GUIs which pop out of the Systray.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=110003 Tray Icon Bar Graph (by BeeGee)] - Creates a scrolling bar graph as the tray icon.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=132864 Uskin (by JScript)] - A library that allows a user to skin their application GUI using the Windows ''.MSstyles'' files.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=191821 Wi3SMenu (by NHD)] - Create a slide menu with Windows 10 style. Supports color, icon and opacity.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=32494 XSkin (by Valuater)] - A large library that allows skinning of your GUI and to apply custom skins.<br />
<br />
=== Controls ===<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=146406 Calendar (by jmon)] - Calendar UDF.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=125293 ChooseFileFolder (byMelba23)] - Single and multiple selections from specified path treeview listing.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=96464 Colorpicker (by Yashied)] - Create a button for the user to select a color.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=123409 Explorer Frame UDF (by Beege)] - Takes any frame created by GUIFrame and turns it into a MS-Windows like Explorer window.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=173929 GDIPlus Slider UDF (by Kanashius)] - This UDF can be used to create a slider with an imagebackground and an image to move.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=79412 Graph control (by andybiochem)] - Easily create and show bar chart and line charts.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=104399 GraphGDIPlus UDF (by andybiochem)] - Easily create and show bar chart and line charts with GDI+ to take advantage of double-buffering.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=105682 GUICtrlCreateFinder (by Mat)] - Allows you to create a window finder control like the one seen in AutoIt Window Info.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=107965 GUIHotkey (by Mat)] - UDF for using native hotkey controls.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=182492 GUIListViewEx (by Melba23)] - Insert, delete, move, drag, sort, edit and colour ListView items.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=111438 GUIPager (by Mat)] - Create and control native pager controls.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=20967 GUI/Tray Menu (by Holger, LarsJ, AZJIO)] - GUI/Tray Menu with icons and colors.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=166594 GUITreeViewEx (by Melba23)] - Check/clear parent and child checkboxes in a TreeView.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=90598 Hotkey input control (by Yashied)] - Hotkeys Input Control UDF Library (Non-native).<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=173932 ListView Edit UDF (by Kanashius)] - This UDF can be used to simply edit an Listview.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=109355 ListView - Explorer like ListView UDF (by Beege)] - This UDF simplify creating MS Explorer-like ListViews.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=143711 Marquee (by Melba23)] - Make tickertape info bars.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=143380 Predict Text UDF (by PhoenixXL)] - It sub classes the edit control and matches the current word through the Database & sets selection in accordance.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=74649 Progressbar with GDIplus (by ProgAndy)] - You even can use full textured images.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=151636 RestrictEdit_SRE UDF (by PhoenixXL)] - Restrict the text that can be entered in an editbox through a String Regular Expression.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=128242 Ribbon (by trancexx)] - UDF for Windows Ribbon framework.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=114034 StringSize (by Melba23)] - Automatically size controls to fit the text you want to put in them.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=126958 Syslink (by Yashied)] - Provides a convenient way to embed hypertext links in a window.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=105814 Table (by andybiochem)] - Table UDF.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=125251 TVExplorer (by Yashied)] - Allows to create TreeView (TV) Explorer controls that display a tree of files and folders.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=190659 Virtual Listview (by LarsJ)] - Virtual Listview for large amounts of data with a large number of rows.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=195053 Windows Message Monitor (by LarsJ)] - Monitor Windows Messages of a window or control.<br />
<br />
== Hardware ==<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=118317 Battery UDF (by Yashied)] - Retrieves a various information and current status of the battery(s).<br />
* [https://www.autoitscript.com/forum/topic/154727-buildpartitiontable BuildPartitionTable (by RTFC)] - Scans a physical drive's partition table and returns a partition_table, allocation_table and volumes_table.<br />
* [https://www.autoitscript.com/forum/topic/155674-commapi-serial-and-parallel-communication-with-windows-api/ CommAPI (by therealhanuta)] - Serial and parallel communication (COM port, RS-232, LPT port) - without installing DLL's (using Windows API calls).<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=77731 Device Management (by weaponx)] - Device Management API.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=97487 DirectShow (by monoceres)] - DirectShow UDF.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=164700 DirectSound (by eukalyptus)] - DirectSound UDF.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=164701 Direct2D (by eukalyptus)] - Direct2D UDF.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=99713 Drive Info (by NerdFencer)] - Gathers drive info for Hard Drives, Disk Drives, and Floppy Drives.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=138989 FritzBox (by Allow2010)] - _FB_Tools - manage your FritzBox from Autoit.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=121084 I/O Port Functions (by Ascend4nt)] - Input/Output UDF for interacting with ports (x64 Parallel Port, Keyboard etc.).<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=154350 Monitor Configuration (by jaberwacky)] - Monitor Configuration UDF.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=155469 Mouse (by AlmarM)] - AutoIt powered mouse events.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=147325 MouseTrapEvent (by ozmike)] - MouseTrapEvent UDF.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=149083 NetInfo (by Nessie)] - UDF for test internet download speed and upload speed.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=155539 Network configuration (by jguinch)] - Network configuration UDF.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=182684 Nitgen (by Jefrey)] - UDF to work with Nitgen fingerprint readers that use NGenBio SDK.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=155485 Printers management with WMI (by jguinch)] - Allows to manage printers: add/delete printer, driver, port, or obtain configuration, set default printer ...<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=128546 Serial Port/COM (by martin)] - Serial Port /COM Port UDF.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=27755 SMARTDRIVE (by ptrex)] - SMART drive Analysis.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=158640 SPI Hardware Interface (by Blinky)] - Communicate with the MAX335 chip using the SPI protocol via the LPT (printer) port.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=8188 VISA/GPIB (by Angel)] - VISA/GPIB library.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=68866 Webcam (by LIMITER)] - Webcam UDF.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=70857 Webcam (by ludocus)] - Webcam UDF.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=91018 WiFi (by MattyD)] - Low level control over your wireless LAN.<br />
<br />
== Information gathering ==<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=29404 Computer information (by JSThePatriot)] - A general purpose library to get various details about a Windows machine.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=54039 WinPcap (by JRSmile)] - Wrapper for the windows packet capture library WinPcap.<br />
* [https://opensource.grisambre.net/pcapau3/ WinPcap (by Nicolas Ricquemaque)] - A library to access the main functionalities offered by the WinPcap driver.<br />
<br />
== Internet protocol suite ==<br />
* [https://www.autoitscript.com/forum/topic/178871-dllcall-with-c-example/#comment-1285754 SMSApi (by mLipok)] - UDF for SMSAPi which provides SMS services.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=178589 BulkSMS (by Skysnake)] - UDF for BulkSMS which provides SMS services.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=137456 cURL (by seangriffin)] - A UDF for transferring data with URL syntax.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=173067 cURL (by Ward)] - <s>AutoIt binary code version of libcurl with SSL support.</s> File removed by author.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=187718 HTTP lib (by Jefrey)] - HTTP lib (GET, POST and upload) UDF to simplify HTTP requests, mainly when dealing about POST data or file uploads.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=40243 IMAP (by mikeytown2)] - IMAP.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=108422 IMAP4 (by Tipulatoid)] - IMAP4 UDF.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=43515 IRC (by McGod)] - A lightweight library for communicating with IRC servers.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=159285 IRC (by rcmaehl)] - IRC UDF - Updated Version of Chips' IRC UDF.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=22838 POP3 (by Apzo)] - POP3 library for retrieving email messages. Not compatible with Gmail because it uses SSL.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=167339 POP3 (by mLipok)] - POP3 UDF According to the 1939 RFC, modified version with Quoted Printable decoder.<br />
* <strike>[https://www.autoitscript.com/forum/index.php?showtopic=64051 POP3 SSL (by Fox2)] - A POP3 library that's compatible with Gmail. It uses an external executable that must be supplied with your script.</strike> No code attached to the thread.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=154530 Prowl (by mrflibblehat)] - Push notifications to iPhone, iPod touch or iPad using Prowl (Growl client for iOS).<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=173129 Request (by Ward)] - <s>Powerful and easy-to-use HTTP client for AutoIt based on Curl.au3 and Json.au3.</s> File removed by author.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=138095 SFTP (by Lupo73)] - UDF to support SFTP protocol using PSFTP.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=154054 Socket UDF (by funkey)] - Socket UDF.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=23860 SMTP (by Jos)] - Smtp Mailer That Supports Html And Attachments.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=167292 SMTP Mailer UDF (by mLipok)] - Smtp Mailer That Supports Html And Attachments - Modified Version with support to save EML files.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=81687 SNMP (by enaiman)] - SNMP_UDF for SNMPv1 and SNMPv2c.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=70759 SNMP - MIB protocol (by ptrex)] - Reading toner status from SNMP device with WMI.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=166579 SSH (by jeanphile)] - Use the SSH protocol very easily in your code.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=185329 STUN (by j0kky)] - STUN is a protocol that permits you to know your external IP but, more interesting, your external port associated to your internal port.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=184817 SyslogSend (by Irios)] - This allows sending (BSD) messages to a syslog server using UDP.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=169774 TCPServer (by Jefrey)] - Multi client, event-based, able to bind console app to socket.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=57022 UPnP Protocol (by ptrex)] - UPnP - Read and Control your devices in side out.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=84133 WinHTTP (by trancexx)] - Access the HTTP protocol for creating GET and POST requests and submitting them with conforming standards, cookies not supported.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=77503 WinInet (by -Ultima-)] - Access standard Internet protocols (FTP, Gopher and HTTP). Supports GET/POST requests and cookies.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=191954 WSA_NBTCP (by ripdad)] - Non-Blocking Transmission Control Protocol.<br />
<br />
== Maths ==<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=170658 Advanced Math UDF (by scintilla4evr)] - Advanced mathematical functions (primes, number sequences, interpolate, calculate values of functions like Riemann zeta etc.).<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=102686 Advanced rounding (by Mat)] - Support for different measures of accuracy and 8 ways to resolve tie breaks.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=83529 Big number (by eukalyptus)] - Make calculations with extremely large numbers that AutoIt normally is not able to support.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=106551 Decimal To fraction (by Malkey)] - Converts any decimal number to a fraction. Example: 1.2 to 6/5.<br />
* [https://www.autoitscript.com/forum/files/file/319-eigen4autoit/ Eigen4AutoIt (by RFTC)] - This library allows you to perform fast matrix operations on large numerical data sets, and much more ....<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=140789 MathsEx UDF (by PhoenixXL)] - Functions for Carrying Out More Advanced Mathematical Calculations.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=81189 Number base conversion (by james3mg)] - From, to and between positive bases less than 63 (decimals supported).<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=117156 NumToWord (by Mat)] - Convert numerals to a human readable string.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=108803 Polynomials (by Mat)] - Functions for using polynomials.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=83091 Primes (by jennico)] - Many functions dealing with prime number generation and calculations.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=94770 Roman Numerals (by AZJIO)] - Roman Numerals.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=98160 Root function (by Mat)] - Working out real roots of numbers.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=163899 StringAPL (by minx)] - inline APL interpreter.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=82722 Trigonometric and math functions (by trancexx)] - _ATan2(), _Cosh(), _Frexp(), _Hypot(), _Ldexp(), _Logb(), _Sinh(), _Tanh().<br />
<br />
== Media ==<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=95357 FreeImage library (by ProgAndy)] - Various operations on images, such as rotate, resize, flip.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=127263 HtmlHelp (by Geodetic)] - HtmlHelp UDF.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=116009 HyperCam (by seangriffin)] - HyperCam (Screen Recording) UDF.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=182535 HyCam2 (by willichan)] - Automation for HyCam2 screen recording utility.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=50608 OCR (by ptrex)] - Real OCR in AU3 - MODI with MS Office 2003.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=89542 OCR (by seangriffin)] - Tesseract (Screen OCR) UDF.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=51054 Printer controller (by martin)] - Print text in any font, size and colour at any position on the page, draw lines, curves, elipses, pies in any colour, and print images.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=73993 Printing (by GRS)] - Printing from AutoIt.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=161831 RTF_Printer (by mLipok)] - Printing RichEdit in the background.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=94834 Simple DirectMedia Layer (by AdmiralClaws)] - Adds support for joysticks, CDs, 2D graphics, timers. See [https://www.libsdl.org/ SDL website] for more information.<br />
<br />
===Graphics and image===<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=113881 au3Irrlicht2 (by JRowe)] - Combining Irrlicht and AutoIt.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=130263 AVI writing udf (by monoceres)] - UDF for creating uncompressed avi:s from bitmap files (support for compressing the video, may or may not appear).<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=27362 Bitmap Library (by evilertoaster)] - Bitmap Library.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=150231 GTK+ (by prazetto)] - GTK+ Framework | Widgets.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=13096 ImageGetInfo (by Lazycat)] - This is an UDF for reading info from JPEG, TIFF, BMP, PNG and GIF - size, color depth, resolution.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=70506 IrrLicht (by A. Percy)] - A 3D graphics engine suitable for creating games.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=151011 OpenGL (by LarsJ)] - OpenGL without external libraries etc. For JPEG files UDF also retreive various Exif information.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=148129 OpenGL (2.0) (by minx)] - New set of UDFs for OpenGL + AutoIt.<br />
<br />
===Players===<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=114143 VLC (by seangriffin)] - VLC (Media Player) UDF.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=91316 VLC Media Player (by ptrex)] - VLC Media Player.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=27352 WMP (by ConsultingJoe)] - Windows Media Player UDF.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=44008 WMP - Media Controls (by CFire)] - Another Windows Media Player UDF.<br />
<br />
===Sound===<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=83481 BASS Function Library (by BrettF)] - Sound and Music via wrappers for Bass, BassEnc, Bass FX, BassSFX, BassAsio and BassCd DLLs.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=173808 libZPlay (by Danyfirex)] - Multimedia library for playing mp3, mp2, mp1, ogg, flac, ac3, aac, oga, wav and pcm files and streams.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=37072 MIDI (by eynstyne)] - MIDI UDF.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=114742 SAPIListBox (by seangriffin)] - SAPIListBox (Speech Recognition) UDF.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=100439 TTS (by Beege)] - Text-to-Speech UDF.<br />
<br />
== PDF ==<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=162195 Acrobat Reader - ActiveX Viewer (by mLipok)] - Make your own PDF Viewer GUI with Acrobat Reader ActiveX COM Object "AcroPDF.PDF.1".<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=164469 Debenu PDF Viewer SDK (by mLipok)] - A collection of functions to display PDF files in your applications using Debenu PDF Viewer SDK.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=160875 Debenu Quick PDF Library (by mLipok)] - A collection of functions for Debenu Quick PDF Library.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=75832 FoxIt Reader (by ptrex)] - PDF Reader in AU3.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=118827 MPDF (by taietel)] - Create PDF from your application.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=42776 PDFCreator (by ptrex)] - Automation of PDFCreator allows you to create and manipulate PDF files.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=170550 PDFCreator (by mLipok)] - UDF for PDFCreator v1.x.x with working EVENTs Handler.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=32261 _StringToPDF (by Tam0r)] - Write a string to a PDF file and specify font size, type etc.<br />
<br />
== Security ==<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=150819 VirusTotal (by Danyfirex)] - VirusTotal API 2.0 UDF.<br />
<br />
== Social Media and other Website API ==<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=159254 Cex.io (by AquilesCrespo)] - UDF script for using with the web api from https://cex.io/ server.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=169333 CrowdinAPI (by mLipok)] - Uses the [https://crowdin.com/page/api crowdin.net website API] for some functions (create projects, add and update files, download translations or integrate localization).<br />
* [https://www.autoitscript.com/forum/files/file/290-dropbox-authenticator/ Dropbox authenticator (by Gimerly)] - Dropbox authenticator.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=158106 Easypost (by dcat127)] - Print USPS Postage Labels.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=114801 eBay (by seangriffin)] - eBay UDF (functions GetItemStatus and GetSingleItem from the "Shopping API").<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=141340 Gmail (by PhoenixXL)] - Remote Gmail (UDF).<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=192422 Gmail API (by Ascer)] - Automate communication with Gmail using oAuth 2.0 security. <br />
* [https://www.autoitscript.com/forum/index.php?showtopic=98504 Google Functions (by Beege)] - Google Functions (Suggestions, Definitions, Translate, Convert).<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=115437 Google Maps (by seangriffin)] - Google Maps UDF.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=70675 iTunes (by torels)] - iTunes UDF.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=101802 iTunes (by Beege)] - Another iTunes UDF.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=150985 No-IP (by Nessie)] - With this UDF you can simply update your no-ip hostname(s) and retrieve the ip address of an no-ip address.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=150838 PasteBin (by mrflibblehat)] - Pastebin UDF.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=121767 Skype (by FireFox)] - Skype4COM provides an ActiveX interface to the Skype API.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=113234 Teamspeak 3 (by chipDE)] - Teamspeak 3 UDF.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=186944 TeamViewer API (by mLipok)] - A collection of function for use with TeamViewer API.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=186381 Telegram Bot UDF (by LinkOut)] - UDF for [https://core.telegram.org/api Telegram messenger API].<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=166547 TVmaze.com API (by BBs19)] - TVmaze.com API UDF (TV-Series).<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=116600 Twitter (by seangriffin)] - Twitter UDF.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=149247 Yahoo Weather (by Nessie)] - YWeather UDF - Yahoo Weather API.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=112775 Youtube Uploader (by BrettF)] - AYTU - AutoIt Youtube Uploader.<br />
<br />
== Windows ==<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=50880 ACL (by ptrex)] - Set ACL on windows Objects.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=134508 ACL (by FredAl)] - Do most everything with the DACL and ownership on all types of objects: Files or folders, Registry keys, services, Kernel and WMI objects, etc.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=184937 CertUtil UDF (by mLipok)] - Wrapper for windows certutil.exe (command-line program that is installed in Windows as part of Certificate Services).<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=113560 FileSystemMonitor (by seangriffin)] - Monitors the file system by recording all file system events occurring within a given path.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=145158 Firewall (by JLogan3o13)] - Control and manipulate the Windows Firewall (enable/disable, Exclusions list, enable/disable ports etc.).<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=194015 Firewall policy2 (by Bilgus)]- Provides access to the firewall policy for Windows Vista+.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=111018 ITaskBarList (by Beege)] - ITaskBarList UDF.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=74118 Local account (by engine)] - Local account UDF.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=161193 Magnifier Functions (by Ascend4nt)] - Exposes most of the useful Magnifier API functions available since Windows Vista.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=75250 Registry (by engine)] - Windows Registry UDFs.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=50551 Registry (by seanhart)] - RegWriteAllUsers / RegDeleteAllUsers.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=80201 Service (by arcker)] - Build your own service with AutoIt code.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=124508 Startup (by guinness)] - Create Startup entries in the Startup Folder or Registry.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=164756 SCCM (by JLogan3o13)] - Systems Center Configuration Manager Library.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=134628 System restore (by FredAI)] - System restore UDF.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=186111 SubstWrapper UDF (by mLipok)] - Wrapper for windows subst.exe command - (Associates a path with a drive letter).<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=135994 Taskplanner/Taskscheduler COM (by Allow2010)] - an UDF for using the Windows Taskplaner / Task Scheduler.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=83355 Task Scheduler (by dbzfanatic)] - Task Scheduler UDF.<br />
<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=200068 TaskScheduler (by water)] - Brushed up Task Scheduler UDF.<br />
<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=173934 TTS UDF (by Kanashius)] - UDF for use with SAPI Automation Object - text-to-speech (TTS) engine.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=158377 UAC (by AdamUL)] - User Account Control (UAC) UDF.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=175719 Utter (by Surya)] - Utilizing more of SAPI (Speech Recognition UDF).<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=127075 WIMGAPI (by Homes32)] - A UDF for manipulating Windows Image Files (.wim) without ImageX.exe.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=28436 Windows Events (by Emperor)] - Create your own Windows events.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=6487 Windows Service Control functions (by SumTingWong)] - Some limited functions to control services (create, start, stop, delete, check ...).<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=81880 Windows Services (by engine)] - Windows Services UDF.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=163178 WRMF (by Luigi)] - WRMF - Windows Registry Monitor Call Function.<br />
<br />
== Misc ==<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=145099 _AdlibEnhance (by JScript)] - Enhance Adlib to call functions with parameters, pause and resume.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=160936 Android (by Moriba)] - Control any Android device.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=97826 Animated tray icons (by Yashied)] - Make animated tray icons easily.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=155442 ArrayMultiColSort (by Melba23)] - Function to sort a 2D array on several columns.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=180467 ArrayWorkshop (by czardas)] - Multidimensional array functions.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=59174 Associative array functions (by Nutster)] - Manage a version of associative arrays in single AutoIt variables. <br />
* [https://www.autoitscript.com/forum/index.php?showtopic=163577 Atom Table (by Ascend4nt)] - Store (add, find, delete, and query) strings locally (at program level) or globally (at OS level) with unique numerical identifiers.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=170087 Barcode generators (by willichan)] - Creates a Code128A/B/C or Creates a Code39 or Code39Extended optimized barcode from supplied data.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=131037 Binary (by Ward)] - <s>Functions to better deal with binary variables.</s> File removed by author.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=162366 BinaryCall (by Ward)] - <s>Write Subroutines In C, Call In AutoIt.</s> File removed by author.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=87735 BlockInputEx (by MrCreatoR)] - Supports a few features that built-in BlockInput() function does not.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=29763 Clipboard (by eltorro)] - When apps need to watch the clipboard.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=170630 ClipboardEx (by ozmike)] - Allows to have more than 1 item in the Clipboard. Handles all data types, not just text.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=81267 Clipboard History (by wraithdu)] - Save and restore the entire clipboard contents. Inspired by AHK's ClipboardAll.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=169610 CmdLine (by Jefrey)] - Collection of functions to parse command line arguments.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=126569 Console (by Shaggi)] - Functions and features to work wiht Console input/output.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=121833 Copy (by Yashied)] - Copy or move files and directories without suspending your script. Retrieve the current state (copied bytes, error code etc.) while copying.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=154684 Date / Time convert (by Melba23)] - Transform date/time formats.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=99106 _DLLStructDisplay (by Ascend4nt)] - Show Struct in ListView.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=111613 FASM (by Ward)] - <s>Embed compiled Flat Assembler (FASM) code in your script.</s> File removed by author.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=157689 _FileGetMimeType (by Wiliat87)] - Retrieve MIME types based on the extension of the filename/filepath/URL provided.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=117033 File locking with cooperative semaphores (by willichan)] - Simple file locking without a server.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=157241 FindMimeFromData (by twbradio)] - FindMimeFromData using urlmon.dll.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=181997 Font Icon (by J2TeaM)] - Use Font Awesome in your AutoIt project.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=68422 HotString (by jvanegmond)] - Similar to the HotKey function but trigger on a string, instead of a key or key combination.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=86672 Inline Assembly (by Ward)] - <s>Assembles the code to binary machine code and runs it.</s> File removed by author.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=173946 LASM - Light Assembler (by minxomat)] - Inline UDF for an Assembler.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=161628 LFN (by orbs)] - Overcome MAX_PATH limit of 256 chars.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=111492 Link Grammar for AutoIt (by JRowe)] - Input is a regular sentence in English, German or Italian, output is a pattern parsed from the structure of the sentence.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=77463 MemoryDll (by Ward)] - <s>Embed DLLs in script and call functions from memory.</s> File removed by author.<br />
* [https://www.autoitscript.com/forum/files/file/147-mruau3 MRU (by Yashied)] - Most Recently Used (MRU) List Automation functions.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=186853 _Multiprocess (by jguinch)] - Run several external programs at the same time and retrieve the exit code of each process.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=188158 .NET Common Language Runtime (CLR) Framework (by Danyfirex, Junkew, Larsj, ptrex, Trancexx)] - Allows AutoIt to access .NET Class Libraries.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=101733 NoFocusLines (by Melba23)] - Remove the dotted focus lines from buttons, sliders, radios and checkboxes.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=149176 NotifyIcon (by FireFox)] - Create, delete and manage self notify icons (formerly TrayIconEx). <br />
* [https://www.autoitscript.com/forum/index.php?showtopic=63318 PixelGetColor (by Manadar)] - Get or Read Pixel from memory.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=167024 RDC (by Yashied)] - ReadDirectoryChanges Wrapper.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=51103 Resources (by Zedna)] - Embed any binary data into your AutoIt compiled EXE files.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=162499 ResourcesEx (by guinness)] - Up to date version of Zedna's Resources UDF. <br />
* [https://www.autoitscript.com/forum/index.php?showtopic=111215 Restart (by Yashied)] - Allows to restart a script from any location with full restoration of the original command line parameters.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=51547 SciLexer (by Kip)] - Editing control, supports multiple editors.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=152093 ScriptEditor (by pandel)] - ScriptEditor with I18N support and customizable lexer completely written in AutoIt (based on SciLexer).<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=162033 Spell Checker (by iCode)] - Spell Checker functions to call Hunspell, Hyphenate and MyThes.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=164444 Synology filestation (by nend)] - Functions to interact with a Synology NAS server.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=163328 TimeConvert (by orbs)] - Convert UTC to/from local time, and/or reformat the string representation.<br />
* [https://www.autoitscript.com/forum/index.php?showtopic=129196 WinSnap (by Beege)] - Automatic Window Alignment by applying that "snappy edge" effect to your GUI.<br />
[[Category:UDF]]</div>Skysnakehttps://www.autoitscript.com/w/index.php?title=Known_issues_with_Microsoft_Office_automation.&diff=14284Known issues with Microsoft Office automation.2020-04-21T08:01:38Z<p>Skysnake: </p>
<hr />
<div>AutoIt provides a powerful integration and manipulation tool for the MS Windows environment and the WinAPI. Some features of Microsoft's Windows and Office products are proprietary and cannot readily be manipulated. Sometimes workarounds are required. It should be noted that some of these issues change over different versions, resulting in "unexplained" errors or unexpected behavior. This pages is dedicated to identifying those issues, provide explanations and list solutions or workarounds.<br />
<br />
Also, please note that since MS Office products function within the Windows environment, the behavior of different components may be mutually interdependent. Simply changing one setting in a specific box, may not have same or desired effect across all platforms and all versions. The uniform use of Windows 10 should reduce these issues.<br />
<br />
== Microsoft Outlook Email WINMAIL.DAT ==<br />
<br />
=== The Problem ===<br />
<br />
''Microsoft mail products such as Outlook, Office 365 and Exchange may send mail messages in a proprietary format known as TNEF that only other Microsoft products accept. Find out how to configure your Microsoft product in the list below so it doesn’t send messages in the TNEF format.''<br />
From [https://capsulecrm.com/support/microsoft-tnef/ Capsule CRM]<br />
<br />
Email sent using Outlook may be formatted using the Microsoft proprietary TNEF format. Sending the mail appears correct, but the recipient typically receives and email attachment in winmail.dat format. A quick search will indicate just how wide spread this problem is.<br />
<br />
=== The Cause ===<br />
<br />
Transport Neutral Encapsulation Format or TNEF is a proprietary email attachment format used by Microsoft Outlook and Microsoft Exchange Server. An attached file with TNEF encoding is most often named winmail.dat or win.dat, and has a MIME type of Application/MS-TNEF. The official (IANA) media type, however, is application/vnd.ms-tnef.<br />
Fronm this page: [https://en.wikipedia.org/wiki/Transport_Neutral_Encapsulation_Format Wikipedia.org Transport Neutral Encapsulation Format]<br />
<br />
==== Look out for ====<br />
<br />
Microsoft uses "aliases" for the TNEF model.<br />
These include "Sending in Rich Text Format". The mail is not sent in RTF but rather forces TNEF encoding.<br />
Sending in Plain or HTML format appears to prefer non-TNEF, but sometimes fails.<br />
<br />
=== Solutions ===<br />
<br />
Microsoft does not provide a single "Do not use TNEF" configuration item. Settings are dispersed over several interfaces.<br />
<br />
The preferred solution appears to prevent MS Outlook from sending TNEF encoded messages. There is no control over the decoding of the message as received. By preventing the Senders use of TNEF, this problem may be mitigated.<br />
<br />
==== Windows Registry ====<br />
<br />
''I added a DWORD named "DisableTNEF" to the key HKEY_CURRENT_USER\Software\Microsoft\Office\16.0\Outlook\Preferences. I set the value at 1.''<br />
From [https://answers.microsoft.com/en-us/msoffice/forum/all/outlook-2016-winmaildat-problem-have-tried-all/f9f15b95-7fdc-4f1c-a1d9-047358747ef8 Microsoft Answers]<br />
<br />
==== In Outlook 2016 ====<br />
If you send emails via Office 365 when using Outlook 2016, refer to the Office 365 configuration.<br />
<br />
Alternatively if you send messages from Outlook 2016 via a different mail server or want a solution that avoids configuration of Office 365, follow these steps to turn off TNEF:<br />
* Click the File tab, click Options, and then click on Mail.<br />
* In the Compose in this message format list, click Plain Text or HTML, and then click OK.<br />
* Also clear any preferences associated with Outlook’s auto complete list.<br />
Go to File Options Mail Send Messages section.<br />
Click Empty Auto-Complete List<br />
<br />
==== In Outlook 2013 & 2010 ====<br />
To turn off TNEF, follow these steps:<br />
* Click the File tab, click Options, and then click Mail.<br />
* In the Compose in this message format list, click Plain Text or HTML, and then click OK.<br />
<br />
==== In Outlook 2007 ====<br />
To turn off TNEF, follow these steps:<br />
* On the Tools menu, click Options and then click the Mail Format tab.<br />
* In the Compose in this message format list, click Plain Text or HTML, and then click OK</div>Skysnakehttps://www.autoitscript.com/w/index.php?title=Known_issues_with_Microsoft_Office_automation.&diff=14283Known issues with Microsoft Office automation.2020-04-21T07:59:21Z<p>Skysnake: </p>
<hr />
<div>AutoIt provides a powerful integration and manipulation tool for the MS Windows environment and the WinAPI. Some features of Microsoft's Windows and Office products are proprietary and cannot readily be manipulated. Sometimes workarounds are required. It should be noted that some of these issues change over different versions, resulting in "unexplained" errors or unexpected behavior. This pages is dedicated to identifying those issues, provide explanations and list solutions or workarounds.<br />
<br />
Also, please note that since MS Office products function within the Windows environment, the behavior of different components may be mutually interdependent. Simply changing one setting in a specific box, may not have same or desired effect across all platforms and all versions. The uniform use of Windows 10 should reduce these issues.<br />
<br />
== Microsoft Outlook Email WINMAIL.DAT ==<br />
<br />
=== The Problem ===<br />
<br />
''Microsoft mail products such as Outlook, Office 365 and Exchange may send mail messages in a proprietary format known as TNEF that only other Microsoft products accept. Find out how to configure your Microsoft product in the list below so it doesn’t send messages in the TNEF format.''<br />
From [https://capsulecrm.com/support/microsoft-tnef/ Capsule CRM]<br />
<br />
Email sent using Outlook may be formatted using the Microsoft proprietary TNEF format. Sending the mail appears correct, but the recipient typically receives and email attachment in winmail.dat format. A quick search will indicate just how wide spread this problem is.<br />
<br />
=== The Cause ===<br />
<br />
Transport Neutral Encapsulation Format or TNEF is a proprietary email attachment format used by Microsoft Outlook and Microsoft Exchange Server. An attached file with TNEF encoding is most often named winmail.dat or win.dat, and has a MIME type of Application/MS-TNEF. The official (IANA) media type, however, is application/vnd.ms-tnef.<br />
Fronm this page: [https://en.wikipedia.org/wiki/Transport_Neutral_Encapsulation_Format Wikipedia.org Transport Neutral Encapsulation Format]<br />
<br />
==== Look out for ====<br />
<br />
Microsoft uses "aliases" for the TNEF model.<br />
These include "Sending in Rich Text Format". The mail is not sent in RTF but rather forces TNEF encoding.<br />
Sending in Plain or HTML format appears to prefer non-TNEF, but sometimes fails.<br />
<br />
=== Solutions ===<br />
<br />
Microsoft does not provide a single "Do not use TNEF" configuration item. Settings are dispersed over several interfaces.<br />
<br />
The preferred solution appears to prevent MS Outlook from sending TNEF encoded messages. There is no control over the decoding of the message as received. By preventing the Senders use of TNEF, this problem may be mitigated.<br />
<br />
==== Windows Registry ====<br />
<br />
I added a DWORD named "DisableTNEF" to the key HKEY_CURRENT_USER\Software\Microsoft\Office\16.0\Outlook\Preferences. I set the value at 1.<br />
From [https://answers.microsoft.com/en-us/msoffice/forum/all/outlook-2016-winmaildat-problem-have-tried-all/f9f15b95-7fdc-4f1c-a1d9-047358747ef8 Microsoft Answers]<br />
<br />
==== In Outlook 2016 ====<br />
If you send emails via Office 365 when using Outlook 2016, refer to the Office 365 configuration.<br />
<br />
Alternatively if you send messages from Outlook 2016 via a different mail server or want a solution that avoids configuration of Office 365, follow these steps to turn off TNEF:<br />
* Click the File tab, click Options, and then click on Mail.<br />
* In the Compose in this message format list, click Plain Text or HTML, and then click OK.<br />
* Also clear any preferences associated with Outlook’s auto complete list.<br />
Go to File Options Mail Send Messages section.<br />
Click Empty Auto-Complete List<br />
<br />
==== In Outlook 2013 & 2010 ====<br />
To turn off TNEF, follow these steps:<br />
* Click the File tab, click Options, and then click Mail.<br />
* In the Compose in this message format list, click Plain Text or HTML, and then click OK.<br />
<br />
==== In Outlook 2007 ====<br />
To turn off TNEF, follow these steps:<br />
* On the Tools menu, click Options and then click the Mail Format tab.<br />
* In the Compose in this message format list, click Plain Text or HTML, and then click OK</div>Skysnakehttps://www.autoitscript.com/w/index.php?title=Known_issues_with_Microsoft_Office_automation.&diff=14282Known issues with Microsoft Office automation.2020-04-21T07:52:51Z<p>Skysnake: </p>
<hr />
<div>AutoIt provides a powerful integration and manipulation tool for the MS Windows environment and the WinAPI. Some features of Microsoft's Windows and Office products are proprietary and cannot readily be manipulated. Sometimes workarounds are required. It should be noted that some of these issues change over different versions, resulting in "unexplained" errors or unexpected behavior. This pages is dedicated to identifying those issues, provide explanations and list solutions or workarounds.<br />
<br />
Also, please note that since MS Office products function within the Windows environment, the behavior of different components may be mutually interdependent. Simply changing one setting in a specific box, may not have same or desired effect across all platforms and all versions. The uniform use of Windows 10 should reduce these issues.<br />
<br />
== Microsoft Outlook Email WINMAIL.DAT ==<br />
<br />
=== The Problem ===<br />
<br />
''Microsoft mail products such as Outlook, Office 365 and Exchange may send mail messages in a proprietary format known as TNEF that only other Microsoft products accept. Find out how to configure your Microsoft product in the list below so it doesn’t send messages in the TNEF format.''<br />
From [https://capsulecrm.com/support/microsoft-tnef/ Capsule CRM]<br />
<br />
Email sent using Outlook may be formatted using the Microsoft proprietary TNEF format. Sending the mail appears correct, but the recipient typically receives and email attachment in winmail.dat format. A quick search will indicate just how wide spread this problem is.<br />
<br />
=== The Cause ===<br />
<br />
Transport Neutral Encapsulation Format or TNEF is a proprietary email attachment format used by Microsoft Outlook and Microsoft Exchange Server. An attached file with TNEF encoding is most often named winmail.dat or win.dat, and has a MIME type of Application/MS-TNEF. The official (IANA) media type, however, is application/vnd.ms-tnef.<br />
Fronm this page: [https://en.wikipedia.org/wiki/Transport_Neutral_Encapsulation_Format Wikipedia.org Transport Neutral Encapsulation Format]<br />
<br />
==== Look out for ====<br />
<br />
Microsoft uses "aliases" for the TNEF model.<br />
These include "Sending in Rich Text Format". The mail is not sent in RTF but rather forces TNEF encoding.<br />
<br />
=== Solutions ===<br />
<br />
The preferred solution appears to prevent MS Outlook from sending TNEF encoded messages. There is no control over the decoding of the message as received. By preventing the Senders use of TNEF, this problem may be mitigated.</div>Skysnakehttps://www.autoitscript.com/w/index.php?title=Known_issues_with_Microsoft_Office_automation.&diff=14281Known issues with Microsoft Office automation.2020-04-21T07:52:17Z<p>Skysnake: </p>
<hr />
<div>AutoIt provides a powerful integration and manipulation tool for the MS Windows environment and the WinAPI. Some features of Microsoft's Windows and Office products are proprietary and cannot readily be manipulated. Sometimes workarounds are required. It should be noted that some of these issues change over different versions, resulting in "unexplained" errors or unexpected behavior. This pages is dedicated to identifying those issues, provide explanations and list solutions or workarounds.<br />
<br />
Also, please note that since MS Office products function within the Windows environment, the behavior of different components may be mutually interdependent. Simply changing one setting in a specific box, may not have same or desired effect across all platforms and all versions. The uniform use of Windows 10 should reduce these issues.<br />
<br />
== Microsoft Outlook Email WINMAIL.DAT ==<br />
<br />
=== The Problem ===<br />
<br />
Microsoft mail products such as Outlook, Office 365 and Exchange may send mail messages in a proprietary format known as TNEF that only other Microsoft products accept. Find out how to configure your Microsoft product in the list below so it doesn’t send messages in the TNEF format.<br />
From [https://capsulecrm.com/support/microsoft-tnef/ Capsule CRM]<br />
<br />
Email sent using Outlook may be formatted using the Microsoft proprietary TNEF format. Sending the mail appears correct, but the recipient typically receives and email attachment in winmail.dat format. A quick search will indicate just how wide spread this problem is.<br />
<br />
=== The Cause ===<br />
<br />
Transport Neutral Encapsulation Format or TNEF is a proprietary email attachment format used by Microsoft Outlook and Microsoft Exchange Server. An attached file with TNEF encoding is most often named winmail.dat or win.dat, and has a MIME type of Application/MS-TNEF. The official (IANA) media type, however, is application/vnd.ms-tnef.<br />
Fronm this page: [https://en.wikipedia.org/wiki/Transport_Neutral_Encapsulation_Format Wikipedia.org Transport Neutral Encapsulation Format]<br />
<br />
==== Look out for ====<br />
<br />
Microsoft uses "aliases" for the TNEF model.<br />
These include "Sending in Rich Text Format". The mail is not sent in RTF but rather forces TNEF encoding.<br />
<br />
=== Solutions ===<br />
<br />
The preferred solution appears to prevent MS Outlook from sending TNEF encoded messages. There is no control over the decoding of the message as received. By preventing the Senders use of TNEF, this problem may be mitigated.</div>Skysnakehttps://www.autoitscript.com/w/index.php?title=Known_issues_with_Microsoft_Office_automation.&diff=14280Known issues with Microsoft Office automation.2020-04-21T07:46:54Z<p>Skysnake: </p>
<hr />
<div>AutoIt provides a powerful integration and manipulation tool for the MS Windows environment and the WinAPI. Some features of Microsoft's Windows and Office products are proprietary and cannot readily be manipulated. Sometimes workarounds are required. It should be noted that some of these issues change over different versions, resulting in "unexplained" errors or unexpected behavior. This pages is dedicated to identifying those issues, provide explanations and list solutions or workarounds.<br />
<br />
Also, please note that since MS Office products function within the Windows environment, the behavior of different components may be mutually interdependent. Simply changing one setting in a specific box, may not have same or desired effect across all platforms and all versions. The uniform use of Windows 10 should reduce these issues.<br />
<br />
== Microsoft Outlook Email WINMAIL.DAT ==<br />
<br />
=== The Problem ===<br />
<br />
Email sent using Outlook may be formatted using the Microsoft proprietary TNEF format. Sending the mail appears correct, but the recipient typically receives and email attachment in winmail.dat format. A quick search will indicate just how wide spread this problem is.<br />
<br />
=== The Cause ===<br />
<br />
Transport Neutral Encapsulation Format or TNEF is a proprietary email attachment format used by Microsoft Outlook and Microsoft Exchange Server. An attached file with TNEF encoding is most often named winmail.dat or win.dat, and has a MIME type of Application/MS-TNEF. The official (IANA) media type, however, is application/vnd.ms-tnef.<br />
Fronm this page: [https://en.wikipedia.org/wiki/Transport_Neutral_Encapsulation_Format Wikipedia.org Transport Neutral Encapsulation Format]<br />
<br />
==== Look out for ====<br />
<br />
Microsoft uses "aliases" for the TNEF model.</div>Skysnakehttps://www.autoitscript.com/w/index.php?title=Known_issues_with_Microsoft_Office_automation.&diff=14279Known issues with Microsoft Office automation.2020-04-21T07:43:32Z<p>Skysnake: </p>
<hr />
<div>AutoIt provides a powerful integration and manipulation tool for the MS Windows environment and the WinAPI. Some features of Microsoft's Windows and Office products are proprietary and cannot readily be manipulated. Sometimes workarounds are required. It should be noted that some of these issues change over different versions, resulting in "unexplained" errors or unexpected behavior. This pages is dedicated to identifying those issues, provide explanations and list solutions or workarounds.<br />
<br />
Also, please note that since MS Office products function within the Windows environment, the behavior of different components may be mutually interdependent. Simply changing one setting in a specific box, may not have same or desired effect across all platforms and all versions. The uniform use of Windows 10 should reduce these issues.<br />
<br />
== Microsoft Outlook Email WINMAIL.DAT ==<br />
<br />
Transport Neutral Encapsulation Format or TNEF is a proprietary email attachment format used by Microsoft Outlook and Microsoft Exchange Server. An attached file with TNEF encoding is most often named winmail.dat or win.dat, and has a MIME type of Application/MS-TNEF. The official (IANA) media type, however, is application/vnd.ms-tnef.<br />
Fronm this page: [https://en.wikipedia.org/wiki/Transport_Neutral_Encapsulation_Format Wikipedia.org Transport Neutral Encapsulation Format]</div>Skysnakehttps://www.autoitscript.com/w/index.php?title=Known_issues_with_Microsoft_Office_automation.&diff=14278Known issues with Microsoft Office automation.2020-04-21T07:40:27Z<p>Skysnake: Created page with "AutoIt provides a powerful integration and manipulation tool for the MS Windows environment and the WinAPI. Some features of Microsoft's Windows and Office products are propri..."</p>
<hr />
<div>AutoIt provides a powerful integration and manipulation tool for the MS Windows environment and the WinAPI. Some features of Microsoft's Windows and Office products are proprietary and cannot readily be manipulated. Sometimes workarounds are required. It should be noted that some of these issues change over different versions, resulting in "unexplained" errors or unexpected behavior. This pages is dedicated to identifying those issues, provide explanations and list solutions or workarounds.<br />
<br />
Microsoft <br />
Transport Neutral Encapsulation Format or TNEF is a proprietary email attachment format used by Microsoft Outlook and Microsoft Exchange Server. An attached file with TNEF encoding is most often named winmail.dat or win.dat, and has a MIME type of Application/MS-TNEF. The official (IANA) media type, however, is application/vnd.ms-tnef.<br />
Fronm this page: [https://en.wikipedia.org/wiki/Transport_Neutral_Encapsulation_Format Wikipedia.org Transport Neutral Encapsulation Format]</div>Skysnakehttps://www.autoitscript.com/w/index.php?title=Associative_Arrays&diff=13739Associative Arrays2017-12-04T09:41:15Z<p>Skysnake: </p>
<hr />
<div>In computer science, an associative array, map, symbol table, or dictionary is an abstract data type composed of a collection of (key, value) pairs, such that each possible key appears at most once in the collection.<br />
An associative array differs from a “normal” array in one major way: rather than being indexed numerically (i.e. 0, 1, 2, 3, …), it is indexed by a key, or a language-like word. <br />
A '''Scripting.Dictionary''' is a standard '''''object''''' provided by the '''Microsoft Scripting Runtime''' (scrrun.dll) dependency and is commonly used in VBScript, a reference to which needs to be added in order to create an object in your AutoIt project.<br />
<br /><br />
<br /><br />
This discussion by '''Nutster''' explains the [https://www.autoitscript.com/forum/topic/59174-associative-array-functions/#comment-445963 original implementation] of Associative Arrays in AutoIt. <br />
An associative array is an array where the keys (index numbers) are string instead of integer, as they are in AutoIt. Linux / Unix awk and perl use associative arrays by default. The following functions can be used to manage a version of associative arrays in single AutoIt variables. A hash table is used to store the values because it is faster to insert than other options I can think of and pretty much as fast as them to retrieve the data. The memory requirements are a little higher than other methods, but I think it is a reasonable trade-off. It uses a simple hash function that can probably be easily improved upon and while it can resize the hash table, the resize is slow so try to make your initial size large enough for all your elements. Please see the Include file and an exerciser that demonstrates how to use the associative array functions. Read the comments at the top of each function for more details on their use.<br />
<br /><br />
<br /><br />
<blockquote><br />
<big>Note:</big><br />
<br /><br />
AutoIt allows for at least two different implementations of Associative Arrays. The first method relies on a ''native'' AutoIt internal process handling named array elements, with no reference to the Scripting Dictionary. The second method relies on the Scripting Dictionary to create and manage associative arrays. <br />
</blockquote><br />
<br /><br />
<br />
<br /><br />
<br />
A few notes on Associative Arrays:<br /><br />
* Think of an associative array as an array with named elements<br />
* Comparisons can be exact (binary) or case insensitive (alpha)<br />
<br /><br /><br />
At the time of writing this - 28 November 2017 - a new '''map data type''' is under development for AutoIt. It is availabe in the current [https://www.autoitscript.com/forum/topic/163657-maps-beta/?do=findComment&comment=1296278 beta release].<br />
<br /><br />
<br /><br />
Please also see this entry in the Snippets section of this Wiki [https://www.autoitscript.com/wiki/Snippets_(_AutoIt_Array_)#AssocArray _AssocArray] <br />
<br /><br />
<br /><br />
<br />
A dictionary object example by [https://www.autoitscript.com/forum/profile/2709-mhz/ MHz]<br />
<syntaxhighlight lang='autoit'><br />
; Author Mhz<br />
; Forum https://www.autoitscript.com/forum/topic/182334-scripting-dictionary-modified/<br />
Global $vKey, $sItem, $sMsg, $oDictionary <br />
<br />
; Create dictionary object<br />
$oDictionary = ObjCreate("Scripting.Dictionary")<br />
<br />
If @error Then<br />
MsgBox(0, '', 'Error creating the dictionary object')<br />
Else<br />
; Add keys with items<br />
$oDictionary.Add ("One", "Same" )<br />
$oDictionary.Add ("Two", "Car" )<br />
$oDictionary.Add ("Three", "House" )<br />
$oDictionary.Add ("Four", "Boat" )<br />
<br />
If $oDictionary.Exists('One') Then<br />
; Display item<br />
MsgBox(0x0, 'Item One', $oDictionary.Item('One'), 2)<br />
; Set an item<br />
$oDictionary.Item('One') = 'Changed'<br />
; Display item<br />
MsgBox(0x20, 'Did Item One Change?', $oDictionary.Item('One'), 3)<br />
; Remove key<br />
$oDictionary.Remove('One')<br />
; <br />
$oDictionary.Key ('Two') = 'Bike'<br />
EndIf<br />
<br />
Sleep(1000)<br />
<br />
; Store items into a variable<br />
For $vKey In $oDictionary<br />
$sItem &= $oDictionary.Item($vKey) & @CRLF<br />
Next<br />
<br />
; Display items<br />
MsgBox(0x0, 'Items Count: ' & $oDictionary.Count, $sItem, 3)<br />
<br />
; Add items into an array<br />
$aItems = $oDictionary.Items<br />
<br />
; Display items in the array<br />
For $i = 0 To $oDictionary.Count -1<br />
MsgBox(0x0, 'Items [ ' & $i & ' ]', $aItems[$i], 2)<br />
Next<br />
<br />
Sleep(1000)<br />
<br />
; Add keys into an array<br />
$aKeys = $oDictionary.Keys<br />
<br />
; Display keys in the array<br />
For $i = 0 To $oDictionary.Count -1<br />
MsgBox(0x0, 'Keys [ ' & $i & ' ]', $aKeys[$i], 2)<br />
Next<br />
EndIf<br />
</syntaxhighlight><br />
<br /><br />
<br /><br />
The original AutoIt Scripting Dictionary implementation appears to have been by Gary Frost as far back as 2007. It has since been modified to the following:<br />
<br /><br />
<syntaxhighlight lang='autoit'><br />
#cs<br />
Scripting Dictionary UDF<br />
<br />
Made by GaryFrost <https://www.autoitscript.com/forum/topic/47048-scripting-dictionary/><br />
Modified by Jefrey <jefrey[at]jefrey.ml><br />
<br />
Forum https://www.autoitscript.com/forum/topic/182334-scripting-dictionary-modified/<br />
<br />
#ce<br />
<br />
Func _InitDictionary()<br />
Return ObjCreate("Scripting.Dictionary")<br />
EndFunc ;==>_InitDictionary<br />
<br />
; Adds a key and item pair to a Dictionary object.<br />
Func _AddItem($oDictionary, $v_key, $v_item)<br />
$oDictionary.ADD($v_key, $v_item)<br />
If @error Then Return SetError(1, 1, -1)<br />
EndFunc ;==>_AddItem<br />
<br />
; Returns true if a specified key exists in the Dictionary object, false if it does not.<br />
Func _ItemExists($oDictionary, $v_key)<br />
Return $oDictionary.Exists($v_key)<br />
EndFunc ;==>_ItemExists<br />
<br />
; Returns an item for a specified key in a Dictionary object<br />
Func _Item($oDictionary, $v_key)<br />
Return $oDictionary.Item($v_key)<br />
EndFunc ;==>_Item<br />
<br />
; Sets an item for a specified key in a Dictionary object<br />
Func _ChangeItem($oDictionary, $v_key, $v_item)<br />
$oDictionary.Item($v_key) = $v_item<br />
EndFunc ;==>_ChangeItem<br />
<br />
; Sets a key in a Dictionary object.<br />
Func _ChangeKey($oDictionary, $v_key, $v_newKey)<br />
$oDictionary.Key($v_key) = $v_newKey<br />
EndFunc ;==>_ChangeKey<br />
<br />
; Removes a key, item pair from a Dictionary object.<br />
Func _ItemRemove($oDictionary, $v_key)<br />
$oDictionary.Remove($v_key)<br />
If @error Then Return SetError(1, 1, -1)<br />
EndFunc ;==>_ItemRemove<br />
<br />
; Returns the number of items in a collection or Dictionary object.<br />
Func _ItemCount($oDictionary)<br />
Return $oDictionary.Count<br />
EndFunc ;==>_ItemCount<br />
<br />
; Returns an array containing all the items in a Dictionary object<br />
Func _GetItems($oDictionary)<br />
Return $oDictionary.Items<br />
EndFunc ;==>_GetItems<br />
<br />
Func _Clear($oDictionary)<br />
Return $oDictionary.RemoveAll<br />
EndFunc<br />
<br />
</syntaxhighlight><br />
<br /><br />
<br /><br />
Below are several examples that illustrate the usage of the Scripting Dictionary UDF in AutoIt.<br />
<br /><br />
Example 1:<br />
<syntaxhighlight lang='autoit'><br />
; Author Jefrey<br />
; Forum https://www.autoitscript.com/forum/profile/75137-jefrey/<br />
#include 'scriptingdic.au3'<br />
#include <Array.au3> ; Needed only for _ArrayDisplay, and not required by the lib<br />
<br />
; Init the object<br />
$oObj = _InitDictionary()<br />
<br />
; Adding a single value<br />
_AddItem($oObj, 0, "Test")<br />
; And showing it<br />
msgbox(0, '', _Item($oObj, 0))<br />
<br />
; Adding an array<br />
Dim $aArr[] = [0, -80, -49, -44, 80, 100, 8, 7, 6, 5, 4, 3, 2, 1]<br />
_AddItem($oObj, 1, $aArr)<br />
; And showing it<br />
_ArrayDisplay(_Item($oObj, 1))<br />
<br />
; We can also use this approach:<br />
$oObj3 = _InitDictionary()<br />
$oObj.Add("test", "foo")<br />
MsgBox(0, '', $oObj.Item("test"))<br />
</syntaxhighlight><br />
Example 2 is a reply to a common question asked on the Forum, How to find duplicate lines/values... <br />
<syntaxhighlight lang='autoit'><br />
; Author Malkey <br />
; https://www.autoitscript.com/forum/profile/31256-malkey/<br />
; Forum https://www.autoitscript.com/forum/topic/116156-best-way-to-compare-strings-for-duplicates/?do=findComment&comment=810752<br />
Local $sStr, $begin, $dif, $sMatches<br />
<br />
; Create random test data<br />
For $i = 1 To 1000<br />
$sStr &= Chr(Random(Asc("a"), Asc("z"), 1)) & Chr(Random(Asc("a"), Asc("z"), 1)) & _<br />
Chr(Random(Asc("a"), Asc("z"), 1)) & Chr(Random(Asc("a"), Asc("z"), 1)) & @CRLF ;<br />
Next<br />
;ConsoleWrite($sStr & @CRLF)<br />
<br />
$begin = TimerInit()<br />
<br />
Local $oDict = ObjCreate("Scripting.Dictionary") ; to create a dictionary object<br />
Local $aArray = StringSplit(StringStripWS($sStr, 2), @CRLF, 3)<br />
For $i = 0 To UBound($aArray) - 1<br />
If $oDict.Exists($aArray[$i]) Then<br />
$sMatches &= $i & " " & $aArray[$i] & @CRLF ; Record duplicates<br />
Else<br />
$oDict.add($aArray[$i], '') ; to store a string (you may set $value = '' if you have no use of it)<br />
EndIf<br />
Next<br />
$dif = Round(TimerDiff($begin) / 1000, 3) & " secs"<br />
<br />
;Display results<br />
If $sMatches <> "" Then<br />
MsgBox(0, "Results", StringTrimRight($sMatches, 2) & @CRLF & "Time taken = " & $dif)<br />
Else<br />
MsgBox(0, "Results", "No duplicates found" & @CRLF & "Time taken = " & $dif)<br />
EndIf<br />
</syntaxhighlight><br />
<br /><br />
<br /><br /><br />
<HR><br />
<br />
<br /><br />
While the examples above use the Scripting Dictionary method, the example below by guinness does not use the Scripting Dictionary. Also see [https://www.autoitscript.com/forum/topic/59174-associative-array-functions/ this discussion] by Nutster, with Associative Array management tools. <br />
<br />
The next example does not use the scripting dictionary UDF, but makes use of Global Enumerators. This allows access to data through named elements and uses an ''Object Oriented Programming''-like approach to encapsulate data.<br />
<syntaxhighlight lang='autoit'><br />
; Author guinness<br />
; Forum https://www.autoitscript.com/forum/topic/173803-oop-like-approach-in-autoit/<br />
#include <MsgBoxConstants.au3><br />
<br />
; ---- Start of Person Class<br />
<br />
; Stored in the 'object' to verify it's our 'object' and not some random array<br />
Global Const $PERSON_GUID = '4197B285-6AB1-489B-8585-08C852E33F3D'<br />
<br />
; Friendly names for 0, 1, 2 and 3<br />
Global Enum $PERSON_AGE, $PERSON_NAME, $PERSON_ID, $PERSON_MAX<br />
<br />
; Constructor<br />
Func Person($sName, $iAge)<br />
Local $hPerson[$PERSON_MAX]<br />
<br />
; Set the GUID, so as the verification will work<br />
$hPerson[$PERSON_ID] = $PERSON_GUID<br />
<br />
Person_SetAge($hPerson, $iAge)<br />
Person_SetName($hPerson, $sName)<br />
<br />
; Return the Person 'object'<br />
Return $hPerson<br />
EndFunc ;==>Person<br />
<br />
; Getter for the age property<br />
Func Person_GetAge(ByRef $hPerson)<br />
Return _Person_IsObject($hPerson) ? $hPerson[$PERSON_AGE] : Null<br />
EndFunc ;==>Person_GetAge<br />
<br />
; Setter for the age property<br />
Func Person_SetAge(ByRef $hPerson, $iAge)<br />
; If not a valid 'object' or integer then return<br />
If Not _Person_IsObject($hPerson) Or Not IsInt($iAge) Then Return<br />
<br />
; Set the age<br />
$hPerson[$PERSON_AGE] = $iAge<br />
EndFunc ;==>Person_SetAge<br />
<br />
; Getter for the name property<br />
Func Person_GetName(ByRef $hPerson)<br />
Return _Person_IsObject($hPerson) ? $hPerson[$PERSON_NAME] : Null<br />
EndFunc ;==>Person_GetName<br />
<br />
; Setter for the name property<br />
Func Person_SetName(ByRef $hPerson, $sName)<br />
; If not a valid 'object' then return<br />
If Not _Person_IsObject($hPerson) Then Return<br />
<br />
; Set the name<br />
$hPerson[$PERSON_NAME] = $sName<br />
EndFunc ;==>Person_SetName<br />
<br />
; ToString() for the 'object'<br />
Func Person_ToString(ByRef $hPerson)<br />
Return _Person_IsObject($hPerson) ? StringFormat('Name: %s, Age: %i', $hPerson[$PERSON_NAME], $hPerson[$PERSON_AGE]) : Null<br />
EndFunc ;==>Person_ToString<br />
<br />
; Check if it's a valid 'object' and not some random array. "NTERNAL ONLY!<br />
Func _Person_IsObject(ByRef $hPerson)<br />
Return UBound($hPerson) = $PERSON_MAX And $hPerson[$PERSON_ID] == $PERSON_GUID<br />
EndFunc ;==>_Person_IsObject<br />
<br />
; ---- End of Person Class<br />
<br />
Example()<br />
<br />
Func Example()<br />
; Store the Person 'object', which is just a glorified array<br />
Local $hP1 = Person('John', 30)<br />
<br />
; Display the 'object'<br />
MsgBox($MB_SYSTEMMODAL, 'Person 1', Person_ToString($hP1))<br />
<br />
; Create a new person<br />
<br />
; Store the Person 'object', which is just a glorified array<br />
Local $hP2 = Person('James', 36)<br />
<br />
; Display the 'object'<br />
MsgBox($MB_SYSTEMMODAL, 'Person 2', Person_ToString($hP2))<br />
<br />
; Set the age for Person 2<br />
Person_SetAge($hP2, 45)<br />
<br />
; Display the 'object'<br />
MsgBox($MB_SYSTEMMODAL, 'Person 2 - Revised', Person_ToString($hP2))<br />
EndFunc ;==>Example<br />
</syntaxhighlight><br />
Please see the current beta for more information on map functions.<br />
<syntaxhighlight lang='autoit'><br />
</syntaxhighlight></div>Skysnakehttps://www.autoitscript.com/w/index.php?title=Associative_Arrays&diff=13738Associative Arrays2017-12-04T09:40:46Z<p>Skysnake: </p>
<hr />
<div>In computer science, an associative array, map, symbol table, or dictionary is an abstract data type composed of a collection of (key, value) pairs, such that each possible key appears at most once in the collection.<br />
An associative array differs from a “normal” array in one major way: rather than being indexed numerically (i.e. 0, 1, 2, 3, …), it is indexed by a key, or a language-like word. <br />
A '''Scripting.Dictionary''' is a standard '''''object''''' provided by the '''Microsoft Scripting Runtime''' (scrrun.dll) dependency and is commonly used in VBScript, a reference to which needs to be added in order to create an object in your AutoIt project.<br />
<br /><br />
<br /><br />
This discussion by '''Nutster''' explains the [https://www.autoitscript.com/forum/topic/59174-associative-array-functions/#comment-445963 original implementation] of Associative Arrays in AutoIt. <br />
An associative array is an array where the keys (index numbers) are string instead of integer, as they are in AutoIt. Linux / Unix awk and perl use associative arrays by default. The following functions can be used to manage a version of associative arrays in single AutoIt variables. A hash table is used to store the values because it is faster to insert than other options I can think of and pretty much as fast as them to retrieve the data. The memory requirements are a little higher than other methods, but I think it is a reasonable trade-off. It uses a simple hash function that can probably be easily improved upon and while it can resize the hash table, the resize is slow so try to make your initial size large enough for all your elements. Please see the Include file and an exerciser that demonstrates how to use the associative array functions. Read the comments at the top of each function for more details on their use.<br />
<br /><br />
<br /><br />
<blockquote><br />
<big>Note:</big><br />
<br /><br />
AutoIt allows for at least two different implementations of Associative Arrays. The first method relies on a ''native'' AutoIt internal process handling named array elements, with no reference to the Scripting Dictionary. The second method relies on the Scripting Dictionary to create and manage associative arrays. <br />
</blockquote><br />
<br /><br />
<br />
<br /><br />
<br />
A few notes on Associative Arrays:<br /><br />
* Think of an associative array as an array with named elements<br />
* Comparisons can be exact (binary) or case insensitive (alpha)<br />
<br /><br /><br />
At the time of writing this - 28 November 2017 - a new '''map data type''' is under development for AutoIt. It is availabe in the current [https://www.autoitscript.com/forum/topic/163657-maps-beta/?do=findComment&comment=1296278 beta release].<br />
<br /><br />
<br /><br />
Please also see this entry in the Snippets section of this Wiki [https://www.autoitscript.com/wiki/Snippets_(_AutoIt_Array_)#AssocArray _AssocArray] <br />
<br /><br />
<br /><br />
<br />
A dictionary object example by [https://www.autoitscript.com/forum/profile/2709-mhz/ MHz]<br />
<syntaxhighlight lang='autoit'><br />
; Author Mhz<br />
; Forum https://www.autoitscript.com/forum/topic/182334-scripting-dictionary-modified/<br />
Global $vKey, $sItem, $sMsg, $oDictionary <br />
<br />
; Create dictionary object<br />
$oDictionary = ObjCreate("Scripting.Dictionary")<br />
<br />
If @error Then<br />
MsgBox(0, '', 'Error creating the dictionary object')<br />
Else<br />
; Add keys with items<br />
$oDictionary.Add ("One", "Same" )<br />
$oDictionary.Add ("Two", "Car" )<br />
$oDictionary.Add ("Three", "House" )<br />
$oDictionary.Add ("Four", "Boat" )<br />
<br />
If $oDictionary.Exists('One') Then<br />
; Display item<br />
MsgBox(0x0, 'Item One', $oDictionary.Item('One'), 2)<br />
; Set an item<br />
$oDictionary.Item('One') = 'Changed'<br />
; Display item<br />
MsgBox(0x20, 'Did Item One Change?', $oDictionary.Item('One'), 3)<br />
; Remove key<br />
$oDictionary.Remove('One')<br />
; <br />
$oDictionary.Key ('Two') = 'Bike'<br />
EndIf<br />
<br />
Sleep(1000)<br />
<br />
; Store items into a variable<br />
For $vKey In $oDictionary<br />
$sItem &= $oDictionary.Item($vKey) & @CRLF<br />
Next<br />
<br />
; Display items<br />
MsgBox(0x0, 'Items Count: ' & $oDictionary.Count, $sItem, 3)<br />
<br />
; Add items into an array<br />
$aItems = $oDictionary.Items<br />
<br />
; Display items in the array<br />
For $i = 0 To $oDictionary.Count -1<br />
MsgBox(0x0, 'Items [ ' & $i & ' ]', $aItems[$i], 2)<br />
Next<br />
<br />
Sleep(1000)<br />
<br />
; Add keys into an array<br />
$aKeys = $oDictionary.Keys<br />
<br />
; Display keys in the array<br />
For $i = 0 To $oDictionary.Count -1<br />
MsgBox(0x0, 'Keys [ ' & $i & ' ]', $aKeys[$i], 2)<br />
Next<br />
EndIf<br />
</syntaxhighlight><br />
<br /><br />
<br /><br />
The original AutoIt Scripting Dictionary implementation appears to have been by Gary Frost as far back as 2007. It has since been modified to the following:<br />
<br /><br />
<syntaxhighlight lang='autoit'><br />
#cs<br />
Scripting Dictionary UDF<br />
<br />
Made by GaryFrost <https://www.autoitscript.com/forum/topic/47048-scripting-dictionary/><br />
Modified by Jefrey <jefrey[at]jefrey.ml><br />
<br />
Forum https://www.autoitscript.com/forum/topic/182334-scripting-dictionary-modified/<br />
<br />
#ce<br />
<br />
Func _InitDictionary()<br />
Return ObjCreate("Scripting.Dictionary")<br />
EndFunc ;==>_InitDictionary<br />
<br />
; Adds a key and item pair to a Dictionary object.<br />
Func _AddItem($oDictionary, $v_key, $v_item)<br />
$oDictionary.ADD($v_key, $v_item)<br />
If @error Then Return SetError(1, 1, -1)<br />
EndFunc ;==>_AddItem<br />
<br />
; Returns true if a specified key exists in the Dictionary object, false if it does not.<br />
Func _ItemExists($oDictionary, $v_key)<br />
Return $oDictionary.Exists($v_key)<br />
EndFunc ;==>_ItemExists<br />
<br />
; Returns an item for a specified key in a Dictionary object<br />
Func _Item($oDictionary, $v_key)<br />
Return $oDictionary.Item($v_key)<br />
EndFunc ;==>_Item<br />
<br />
; Sets an item for a specified key in a Dictionary object<br />
Func _ChangeItem($oDictionary, $v_key, $v_item)<br />
$oDictionary.Item($v_key) = $v_item<br />
EndFunc ;==>_ChangeItem<br />
<br />
; Sets a key in a Dictionary object.<br />
Func _ChangeKey($oDictionary, $v_key, $v_newKey)<br />
$oDictionary.Key($v_key) = $v_newKey<br />
EndFunc ;==>_ChangeKey<br />
<br />
; Removes a key, item pair from a Dictionary object.<br />
Func _ItemRemove($oDictionary, $v_key)<br />
$oDictionary.Remove($v_key)<br />
If @error Then Return SetError(1, 1, -1)<br />
EndFunc ;==>_ItemRemove<br />
<br />
; Returns the number of items in a collection or Dictionary object.<br />
Func _ItemCount($oDictionary)<br />
Return $oDictionary.Count<br />
EndFunc ;==>_ItemCount<br />
<br />
; Returns an array containing all the items in a Dictionary object<br />
Func _GetItems($oDictionary)<br />
Return $oDictionary.Items<br />
EndFunc ;==>_GetItems<br />
<br />
Func _Clear($oDictionary)<br />
Return $oDictionary.RemoveAll<br />
EndFunc<br />
<br />
</syntaxhighlight><br />
<br /><br />
<br /><br />
Below are several examples that illustrate the usage of the Scripting Dictionary UDF in AutoIt.<br />
<br /><br />
Example 1:<br />
<syntaxhighlight lang='autoit'><br />
; Author Jefrey<br />
; Forum https://www.autoitscript.com/forum/profile/75137-jefrey/<br />
#include 'scriptingdic.au3'<br />
#include <Array.au3> ; Needed only for _ArrayDisplay, and not required by the lib<br />
<br />
; Init the object<br />
$oObj = _InitDictionary()<br />
<br />
; Adding a single value<br />
_AddItem($oObj, 0, "Test")<br />
; And showing it<br />
msgbox(0, '', _Item($oObj, 0))<br />
<br />
; Adding an array<br />
Dim $aArr[] = [0, -80, -49, -44, 80, 100, 8, 7, 6, 5, 4, 3, 2, 1]<br />
_AddItem($oObj, 1, $aArr)<br />
; And showing it<br />
_ArrayDisplay(_Item($oObj, 1))<br />
<br />
; We can also use this approach:<br />
$oObj3 = _InitDictionary()<br />
$oObj.Add("test", "foo")<br />
MsgBox(0, '', $oObj.Item("test"))<br />
</syntaxhighlight><br />
Example 2 is a reply to a common question asked on the Forum, How to find duplicate lines/values... <br />
<syntaxhighlight lang='autoit'><br />
; Author Malkey <br />
; https://www.autoitscript.com/forum/profile/31256-malkey/<br />
; Forum https://www.autoitscript.com/forum/topic/116156-best-way-to-compare-strings-for-duplicates/?do=findComment&comment=810752<br />
Local $sStr, $begin, $dif, $sMatches<br />
<br />
; Create random test data<br />
For $i = 1 To 1000<br />
$sStr &= Chr(Random(Asc("a"), Asc("z"), 1)) & Chr(Random(Asc("a"), Asc("z"), 1)) & _<br />
Chr(Random(Asc("a"), Asc("z"), 1)) & Chr(Random(Asc("a"), Asc("z"), 1)) & @CRLF ;<br />
Next<br />
;ConsoleWrite($sStr & @CRLF)<br />
<br />
$begin = TimerInit()<br />
<br />
Local $oDict = ObjCreate("Scripting.Dictionary") ; to create a dictionary object<br />
Local $aArray = StringSplit(StringStripWS($sStr, 2), @CRLF, 3)<br />
For $i = 0 To UBound($aArray) - 1<br />
If $oDict.Exists($aArray[$i]) Then<br />
$sMatches &= $i & " " & $aArray[$i] & @CRLF ; Record duplicates<br />
Else<br />
$oDict.add($aArray[$i], '') ; to store a string (you may set $value = '' if you have no use of it)<br />
EndIf<br />
Next<br />
$dif = Round(TimerDiff($begin) / 1000, 3) & " secs"<br />
<br />
;Display results<br />
If $sMatches <> "" Then<br />
MsgBox(0, "Results", StringTrimRight($sMatches, 2) & @CRLF & "Time taken = " & $dif)<br />
Else<br />
MsgBox(0, "Results", "No duplicates found" & @CRLF & "Time taken = " & $dif)<br />
EndIf<br />
</syntaxhighlight><br />
<br /><br />
<br /><br /><br />
<HR><br />
__________________________________________________________________________<br />
<br /><br />
While the examples above use the Scripting Dictionary method, the example below by guinness does not use the Scripting Dictionary. Also see [https://www.autoitscript.com/forum/topic/59174-associative-array-functions/ this discussion] by Nutster, with Associative Array management tools. <br />
<br />
The next example does not use the scripting dictionary UDF, but makes use of Global Enumerators. This allows access to data through named elements and uses an ''Object Oriented Programming''-like approach to encapsulate data.<br />
<syntaxhighlight lang='autoit'><br />
; Author guinness<br />
; Forum https://www.autoitscript.com/forum/topic/173803-oop-like-approach-in-autoit/<br />
#include <MsgBoxConstants.au3><br />
<br />
; ---- Start of Person Class<br />
<br />
; Stored in the 'object' to verify it's our 'object' and not some random array<br />
Global Const $PERSON_GUID = '4197B285-6AB1-489B-8585-08C852E33F3D'<br />
<br />
; Friendly names for 0, 1, 2 and 3<br />
Global Enum $PERSON_AGE, $PERSON_NAME, $PERSON_ID, $PERSON_MAX<br />
<br />
; Constructor<br />
Func Person($sName, $iAge)<br />
Local $hPerson[$PERSON_MAX]<br />
<br />
; Set the GUID, so as the verification will work<br />
$hPerson[$PERSON_ID] = $PERSON_GUID<br />
<br />
Person_SetAge($hPerson, $iAge)<br />
Person_SetName($hPerson, $sName)<br />
<br />
; Return the Person 'object'<br />
Return $hPerson<br />
EndFunc ;==>Person<br />
<br />
; Getter for the age property<br />
Func Person_GetAge(ByRef $hPerson)<br />
Return _Person_IsObject($hPerson) ? $hPerson[$PERSON_AGE] : Null<br />
EndFunc ;==>Person_GetAge<br />
<br />
; Setter for the age property<br />
Func Person_SetAge(ByRef $hPerson, $iAge)<br />
; If not a valid 'object' or integer then return<br />
If Not _Person_IsObject($hPerson) Or Not IsInt($iAge) Then Return<br />
<br />
; Set the age<br />
$hPerson[$PERSON_AGE] = $iAge<br />
EndFunc ;==>Person_SetAge<br />
<br />
; Getter for the name property<br />
Func Person_GetName(ByRef $hPerson)<br />
Return _Person_IsObject($hPerson) ? $hPerson[$PERSON_NAME] : Null<br />
EndFunc ;==>Person_GetName<br />
<br />
; Setter for the name property<br />
Func Person_SetName(ByRef $hPerson, $sName)<br />
; If not a valid 'object' then return<br />
If Not _Person_IsObject($hPerson) Then Return<br />
<br />
; Set the name<br />
$hPerson[$PERSON_NAME] = $sName<br />
EndFunc ;==>Person_SetName<br />
<br />
; ToString() for the 'object'<br />
Func Person_ToString(ByRef $hPerson)<br />
Return _Person_IsObject($hPerson) ? StringFormat('Name: %s, Age: %i', $hPerson[$PERSON_NAME], $hPerson[$PERSON_AGE]) : Null<br />
EndFunc ;==>Person_ToString<br />
<br />
; Check if it's a valid 'object' and not some random array. "NTERNAL ONLY!<br />
Func _Person_IsObject(ByRef $hPerson)<br />
Return UBound($hPerson) = $PERSON_MAX And $hPerson[$PERSON_ID] == $PERSON_GUID<br />
EndFunc ;==>_Person_IsObject<br />
<br />
; ---- End of Person Class<br />
<br />
Example()<br />
<br />
Func Example()<br />
; Store the Person 'object', which is just a glorified array<br />
Local $hP1 = Person('John', 30)<br />
<br />
; Display the 'object'<br />
MsgBox($MB_SYSTEMMODAL, 'Person 1', Person_ToString($hP1))<br />
<br />
; Create a new person<br />
<br />
; Store the Person 'object', which is just a glorified array<br />
Local $hP2 = Person('James', 36)<br />
<br />
; Display the 'object'<br />
MsgBox($MB_SYSTEMMODAL, 'Person 2', Person_ToString($hP2))<br />
<br />
; Set the age for Person 2<br />
Person_SetAge($hP2, 45)<br />
<br />
; Display the 'object'<br />
MsgBox($MB_SYSTEMMODAL, 'Person 2 - Revised', Person_ToString($hP2))<br />
EndFunc ;==>Example<br />
</syntaxhighlight><br />
Please see the current beta for more information on map functions.<br />
<syntaxhighlight lang='autoit'><br />
</syntaxhighlight></div>Skysnakehttps://www.autoitscript.com/w/index.php?title=Arrays&diff=13737Arrays2017-12-01T11:24:54Z<p>Skysnake: </p>
<hr />
<div>An '''array''' is a [[Data_Structures|data structure]] which stores elements (variables) aligned in a computer's memory. Arrays are referenced by an [[identifier]] (variable name) and an index specifying a desired element. The array concept seems complex but the concept can be easily grasped. Why are arrays so important? The array is a fundamental data structure found in most programming languages. <br />
<br />
This tutorial targets people who are beginners. To understand how arrays work, it is imperative to try out and modify the provided samples. Make sure that each concept is understood before the next concept is attempted. This tutorial assumes the use of the SciTE editor. There is a minimal version of SciTE included in the latest stable release of AutoIt (version 3.2.0.1 and above).<br />
<br />
== Declaring Arrays in AutoIt ==<br />
<br />
An array is declared in the same manner as a variable in AutoIt. The difference is that for an array, extra information on how many elements are to be included in the array must be specified. This information is provided by adding brackets after the identifier and a number indicating how many elements the array will possess. <br />
<br />
<syntaxhighlight lang='autoit'><br />
Global $arr[4] ; Will make space for 4 elements.<br />
Local $arr[1] ; Will make space for 1 element.<br />
Dim $arr[3] ; Will make space for 3 elements. Note: Avoid using Dim. Use Global or Local instead.<br />
</syntaxhighlight> <br />
<br />
In AutoIt, a variable may be converted to an array by either using the {{Help File|ReDim}} keyword or assigning a function which returns an array to the variable. <br />
<br />
For example, the function {{Help File|StringSplit}} returns an array which will be assigned to $arr.<br />
<br />
<syntaxhighlight lang='autoit'><br />
Local $arr = StringSplit("This is my string. I want to split it in sentences.", '.')<br />
</syntaxhighlight><br />
<br />
Now to make really certain we have an array from {{Help File|StringSplit}}, we should check it with the {{Help File|IsArray}} built-in function.<br />
<br />
<syntaxhighlight lang='autoit'><br />
If IsArray($arr) Then <br />
; Do work on the array<br />
EndIf<br />
</syntaxhighlight><br />
<br />
== Assigning Data to Array Elements ==<br />
<br />
When we declare the array we make some room in memory for future data. We want to assign some data to the items in the array. Now here is the catch. The array always starts at index zero. So, the first element in the array will be accessed by zero, the second element in the array is accessed at by one and so on.<br />
<br />
<syntaxhighlight lang='autoit'><br />
Local $arr[3] ; Make room for three elements<br />
;Assign some data<br />
$arr[0] = "Element 1"<br />
$arr[1] = "Element 2"<br />
$arr[2] = "Element 3"<br />
</syntaxhighlight><br />
<br />
You can also assign all the data in one smack like this:<br />
<br />
<syntaxhighlight lang='autoit'><br />
Local $arr[3] = ["element 1", "element 2", "element 3"]<br />
</syntaxhighlight><br />
<br />
This zero-based indexing is quite common in most computer languages, but it can be a source of headaches to beginners until it becomes second nature to them. For example, every time you want to loop through a range of elements and the range includes the last element, you have to subtract one from the number of items your array is holding, to get the index of the last item. I.E., An array with three elements has a last index of two.<br />
<br />
So if you don't take zero-based indexing into consideration in your code, you may ask for something outside the memory area set aside for the array. When you do, you get an error message (<font color="red">Array variable has incorrect number of subscripts or subscript dimension range exceeded</font>) and your script will cease execution.<br />
<br />
== Accessing Data in Arrays ==<br />
<br />
Let's walk all elements in the previous sample:<br />
<br />
<syntaxhighlight lang='autoit'><br />
Local $arr[3] = ["element 1", "element 2", "element 3"] <br />
<br />
For $i = 0 to 3 - 1 ; We have an array with three elements but the last index is two.<br />
ConsoleWrite($arr[$i] & @LF)<br />
Next<br />
</syntaxhighlight><br />
<br />
=== Determine Array Size With UBound ===<br />
<br />
The "3 - 1" construct used in the last sample looked strange. It is not a good idea to hard-code size like that. So lets improve our sample a little. <br />
<br />
<syntaxhighlight lang='autoit'><br />
Local $iMax = 3<br />
<br />
Local $arr[$iMax] = ["Element 1", "Element 2", "Element 3"]<br />
<br />
For $i = 0 to $iMax - 1<br />
ConsoleWrite($arr[$i] & @LF)<br />
Next<br />
</syntaxhighlight><br />
<br />
Now that's a bit cleaner. It's also a lot easier to increase or decrease the size of the array. <br><br />
But say you don't know the size of the array upfront because it may come in a variable size when created dynamically.<br />
<br />
<syntaxhighlight lang='autoit'><br />
Local $iMax <br />
<br />
Local $data = "Element 1|Element 2|Element 3" <br />
<br />
; The string in data will be split into an array everywhere | is encountered <br />
Local $arr = StringSplit($data, "|") <br />
<br />
If IsArray($arr) Then<br />
$iMax = UBound($arr); get array size<br />
<br />
ConsoleWrite("Items in the array: " & $iMax & @LF)<br />
<br />
For $i = 0 to $iMax - 1; subtract 1 from size to prevent an out of bounds error<br />
ConsoleWrite($arr[$i] & @LF)<br />
Next<br />
EndIf<br />
</syntaxhighlight><br />
<br />
When you run the above code you will see that $iMax is four and not three as you might have expected. The reason for this is that the developer of the {{Help File|StringSplit}} function thought it was a good idea to use the first item (item zero) to keep a count of valid items in the array. This makes sense in many situations as you now have an array containing data with an index starting at one. So our sample code can now be rewritten like this.<br />
<br />
<syntaxhighlight lang='autoit'><br />
Local $iMax<br />
<br />
Local $data = "Element 1|Element 2|Element 3"<br />
<br />
; The string in data will be split into an array everywhere | is encountered<br />
Local $arr = StringSplit($data, "|") <br />
<br />
If IsArray($arr) Then <br />
For $i = 1 to $arr[0]<br />
ConsoleWrite($arr[$i] & @LF)<br />
Next<br />
EndIf<br />
</syntaxhighlight><br />
<br />
There is another good reason for keeping the count in $arr[0]. When you start to use arrays extensively, you will encounter situations where you have to create an array without knowing how many of the elements you will use. Resizing the array is a relatively expensive operation (in CPU cycles) in most languages.<br />
<br />
Now consider our example if our initial array has reserved space for ten items but we end up only using three. In this case iterating the array using {{Help File|UBound}} will force us to check for empty elements. While iterating with $arr[0] needs no other change than maintaining the correct count in $arr[0].<br />
<br />
<syntaxhighlight lang='autoit'><br />
Local $iMax=10<br />
<br />
;NOTE: We have added the count in the first element<br />
<br />
Local $arr[$iMax] = [3, "Element 1", "Element 2", "Element 3"]<br />
<br />
;NOTE: We use the count in $arr[0] to indicate the last item and we start from index=1<br />
For $i = 1 to $arr[0]<br />
ConsoleWrite($arr[$i] & @LF)<br />
Next<br />
</syntaxhighlight><br />
<br />
== Changing Array Sizes With ReDim ==<br />
<br />
As arrays are critical to algorithm implementations, and in AutoIt even more so as there is no other means of grouping data, we have to understand how to let it grow and shrink. This is where the keyword {{Help File|ReDim}} comes into the picture.<br />
<br />
Let's make an example. We want our array to hold data lines but we don't know how many items we need. We make a guess, in this case five. Now, we use that array to hold data we get from a loop with a random number of iterations. If the array is too small it should automatically be increased. Before we dump the array to output, we should adjust it to the exact size it is supposed to be.<br />
<br />
<syntaxhighlight lang="autoit"><br />
Local Const $iMax = 5<br />
<br />
; NOTE: We have added the count in the first element<br />
Local $arr[$iMax] = [0] ; Initiate the array and place a counter in the first element.<br />
<br />
; Generate a random number between 0 and 20<br />
Local Const $iRandom = Random(0, 20, 1)<br />
<br />
For $i = 1 to $iRandom<br />
; Check that the array is big enough<br />
If UBound($arr) = $i Then<br />
; Resize the array when $i is equal to the element count in the array to prevent subscript error<br />
ReDim $arr[$arr[0] + $iMax]<br />
EndIf<br />
<br />
$arr[$i] = "Item " & $i ; safely add data to new index element<br />
<br />
$arr[0] = $i ; update the index count for future reference<br />
Next<br />
<br />
; Adjust the array size. This time it is probably downward to the size of<br />
; $arr[0] + 1 (remember the first item is $arr[0])<br />
ReDim $arr[$arr[0] + 1] <br />
<br />
; Now dump the results<br />
For $i = 1 to $arr[0]<br />
ConsoleWrite("$arr[" & $i & "]:=" & $arr[$i] & @LF)<br />
Next<br />
<br />
; Visually check that the values are sound<br />
ConsoleWrite("Ubound($arr):=" & UBound($arr) & ", $arr[0]:=" & $arr[0] & ", $iRandom:=" & $iRandom & @LF)<br />
</syntaxhighlight><br />
<br />
Note how the array now has first been adjusted to a multiple of $iMax and in the last part adjusted down to a size matching the data items.<br />
<br />
== Passing Arrays to Functions ==<br />
<br />
There is no special syntax required to pass an array as a function argument unlike a low level language such as C.<br />
The following example demonstrates:<br />
<br />
<syntaxhighlight lang="AutoIt"><br />
Local Const $myArray[5] = [1, 2, 3, 4, 5]<br />
<br />
displayArray($myArray)<br />
<br />
Func displayArray(Const $array)<br />
Local Const $arrayLength = UBound($array)<br />
<br />
For $i = 0 To $arrayLength - 1<br />
MsgBox($MB_OK, "displayArray", $array[$i])<br />
Next<br />
EndFunc<br />
</syntaxhighlight><br />
<br />
You can not declare the variable to hold the array in the function declaration as an array. So, users could pass on a variable. So you have to check that the variable holds an array before you do array specific operations on it.<br />
The following code example will cause an error:<br />
<br />
<syntaxhighlight lang="AutoIt"><br />
Local Const $myArray[5] = [1, 2, 3, 4, 5]<br />
<br />
displayArray($myArray)<br />
<br />
Func displayArray(Const $array[5])<br />
Local Const $arrayLength = UBound($array)<br />
<br />
For $i = 0 To $arrayLength - 1<br />
MsgBox($MB_OK, "displayArray", $array[$i])<br />
Next<br />
EndFunc<br />
</syntaxhighlight><br />
<br />
During the tutorial you have probably noticed that there is a lot of code that is equal in each sample. I'm especially thinking about the code we have used to output the array content. Let's make life easier and create a debug function.<br />
<br />
<syntaxhighlight lang="autoit"><br />
Func dbgArray(ByRef $arr, $msg="")<br />
If $msg <> "" Then <br />
ConsoleWrite("*** " & $msg & " ***" & @LF)<br />
EndIf<br />
<br />
For $i = 0 to UBound($arr) - 1<br />
ConsoleWrite("$arr[" & $i & "]:=" & $arr[$i] & @LF)<br />
Next<br />
<br />
ConsoleWrite( "Ubound($arr)=:=" & UBound($arr) & ", $arr[0]:=" & $arr[0] & @LF) <br />
EndFunc <br />
</syntaxhighlight><br />
<br />
And let's make a little function to fill our arrays with something. Note how the ArrayFiller makes sure it works on an array.<br />
<br />
<syntaxhighlight lang="autoit"><br />
Func ArrayFiller(ByRef $arr)<br />
If IsArray($arr) Then <br />
ReDim $arr[3] ; Notice we might discard content in this operation<br />
Else<br />
Local $foo[3]<br />
$arr = $foo<br />
EndIf <br />
<br />
;Fill the array<br />
$arr[0] = 2<br />
$arr[1] = "Fill 1"<br />
$arr[2] = "Fill 2"<br />
EndFunc <br />
</syntaxhighlight><br />
<br />
And finally some code using the new functions<br />
<syntaxhighlight lang="autoit"><br />
Local $arr1[1]<br />
ArrayFiller($arr1)<br />
dbgArray($arr1)<br />
</syntaxhighlight><br />
<br />
This code is a test on what happens when we pass a regular variable.<br />
<syntaxhighlight lang="autoit"><br />
Local $arr2<br />
ArrayFiller($arr2)<br />
dbgArray($arr2)<br />
</syntaxhighlight><br />
<br />
== Returning Arrays From Functions ==<br />
<br />
As you could observe, in the previous samples, an array will be passed back and forth with the ByRef keyword infront of the variable holding the array in the function declaration.<br />
<br />
We could also have used the Return keyword in a function.<br />
Lets re-work the ArrayFiller function to do this rather than using a variable ByRef.<br />
<br />
<syntaxhighlight lang="autoit"><br />
Func ArrayFiller2()<br />
Local $arr = [3, "Fill 1", "Fill 2"]<br />
Return $arr<br />
EndFunc <br />
</syntaxhighlight><br />
<br />
And now we can use the function like this<br />
<br />
<syntaxhighlight lang="autoit"><br />
Local $foo = ArrayFiller2()<br />
dbgArray($foo)<br />
</syntaxhighlight><br />
<br />
== Comparing Arrays ==<br />
<br />
'''You can not compare complete arrays:'''<br/><br />
<syntaxhighlight lang="autoit"><br />
Local $Array1[3] = [1, 2, 3]<br />
Local $Array2[3] = [1, 2, 3]<br />
Local $Array3[4] = [1, 2, 3, 4]<br />
<br />
If $Array1 == $Array2 Then ConsoleWrite("1.) $Array1 is equal to $Array2! which might be correct in some sense." & @LF); while they contain the same data, the comparison does not work.<br />
<br />
If $Array1 == $Array3 Then ConsoleWrite("2.) $Array1 is equal to $Array3! which is incorrect." & @LF); even though they're different in size, it's incorrectly determined that they're equal.<br />
</syntaxhighlight><br />
<br />
I have the impression that such comparisons compare the memory address of the arrays instead of the array elements values. And the addresses are always different for different arrays. You have to instead, compare all elements one after the other. It might be a good idea to first compare array sizes if that can vary for both the compared arrays!<br />
<br />
The next example creates an array from user input and then compares elements from a 1D Array to the first column of a 2D array to return the matches as words.<br />
<syntaxhighlight lang="autoit"><br />
; sample number string split and convert to words<br />
; uncomment the ConsoleWrite and _ArrayDisplay lines to see what it does<br />
;# some includes<br />
#include <Array.au3><br />
<br />
;# some variables<br />
<br />
;Create 2D array to display<br />
Local $aWords[10][2] = [[0, 'nil'] _<br />
, [1, 'one'] _<br />
, [2, 'two'] _<br />
, [3, 'three'] _<br />
, [4, 'four'] _<br />
, [5, 'five'] _<br />
, [6, 'six'] _<br />
, [7, 'seven'] _<br />
, [8, 'eight'] _<br />
, [9, 'nine']] ; :)<br />
<br />
;~ _ArrayDisplay($aWords)<br />
<br />
; the order of the sample digits is to show that the comparison below is accurate, from left to right<br />
Local $Originalinput = InputBox("Type a number", "A number?","97524601")<br />
<br />
Local $userinput = $Originalinput ; pass the orginal input to a second var<br />
; now parse the userinput to that we know what was submitted, then repeat in words<br />
; first strip all white space<br />
$userinput = StringStripWS($userinput, 8)<br />
<br />
If StringIsDigit($userinput) Then ; continue<br />
<br />
; now get the length of the string<br />
Local $islong = StringLen($userinput)<br />
<br />
; make an array with size = length to insert items into<br />
Local $aInput[1] ; create blank one dimensional array<br />
;~ _ArrayDisplay($aInput)<br />
; eat the string one digit at a time :)<br />
Local $oneleft<br />
For $i = 1 To $islong Step 1<br />
$oneleft = StringLeft($userinput, 1)<br />
ConsoleWrite("$oneleft: " & $oneleft & @CRLF)<br />
$userinput = StringTrimLeft($userinput, 1) ; make the $userinput one shorter on each loop<br />
_ArrayAdd($aInput, $oneleft, 1)<br />
Next<br />
;~ _ArrayDisplay($aInput)<br />
; now write out what the user typed in words<br />
<br />
;~ ConsoleWrite("How long is the string: " & $islong & @CRLF)<br />
; compare the user input to our defined array<br />
For $k = 0 To $islong Step 1<br />
For $j = 0 To (UBound($aWords) - 1) Step 1<br />
;~ ConsoleWrite("Compare $j " & $aWords[$j][0] & " to $k " & $aInput[$k] & @CRLF)<br />
If $aWords[$j][0] == $aInput[$k] Then<br />
MsgBox(0, "Number to word", $Originalinput&@CRLF&"User typed "& $aInput[$k]& @CRLF & $aWords[$j][1] & @CRLF,1)<br />
EndIf<br />
;~ ConsoleWrite("For... Next inner loops: " & $k & @CRLF)<br />
Next<br />
;~ ConsoleWrite("For... Next outer loops: " & $j & @CRLF)<br />
Next<br />
<br />
EndIf ; if its not digits, skip<br />
<br />
</syntaxhighlight><br />
<br />
== Multi Dimensional Arrays ==<br />
<br />
Now what is a good explanation of a multi-dimensional array?<br />
It could be a table where you access one item in the table at a time.<br />
<br />
<syntaxhighlight lang="autoit"><br />
Local $arr[3][3] = [[1, 2, 3], [2, 3, 4], [3, 4, 5]]<br />
<br />
For $i = 0 to UBound( $arr, 1) - 1<br />
For $j = 0 to UBound($arr, 2) - 1<br />
ConsoleWrite("$arr[" & $i & "][" & $j & "]:=" & $arr[$i][$j] & @LF)<br />
Next <br />
<br />
ConsoleWrite(@LF)<br />
Next <br />
</syntaxhighlight><br />
<br />
You can add a number of dimensions not to exceed sixty-four as stated in the help file section [http://www.autoitscript.com/autoit3/docs/appendix/LimitsDefaults.htm AutoIt3 limits/Defaults].<br />
<br />
Here is a four dimensional example. You tell me how that initializer is for readability.<br />
<br />
<syntaxhighlight lang="autoit"> <br />
; NOTE: The following is supposed to be all on one line<br />
; but we use the "_" character to split it into multiple lines for readability<br />
<br />
Local $arr[3][3][3][3] = _<br />
[ _<br />
[ _<br />
[[1, 2, 3], [2, 3, 4], [3, 4, 5]], _<br />
[[1, 2, 3], [2, 3, 4], [3, 4, 5]], _<br />
[[1, 2, 3], [2, 3, 4], [3, 4, 5]] _<br />
], _<br />
[ _<br />
[[1, 2, 3], [2, 3, 4], [3, 4, 5]], _<br />
[[1, 2, 3], [2, 3, 4], [3, 4, 5]], _<br />
[[1, 2, 3], [2, 3, 4], [3, 4, 5]] _<br />
], _<br />
[ _<br />
[[1, 2, 3], [2, 3, 4], [3, 4, 5]], _<br />
[[1, 2, 3], [2, 3, 4], [3, 4, 5]], _<br />
[[1, 2, 3], [2, 3, 4], [3, 4, 5]] _<br />
] _<br />
]<br />
<br />
For $i = 0 To UBound($arr, 1) - 1<br />
For $j = 0 To UBound($arr, 2) - 1<br />
For $k = 0 To UBound($arr, 3) - 1<br />
For $l = 0 To UBound($arr, 4) - 1<br />
ConsoleWrite("$arr[" & $i & "][" & $j & "][" & $k & "][" & $l & "]:=" & $arr[$i][$j][$k][$l] & @LF)<br />
Next<br />
Next<br />
Next<br />
Next<br />
<br />
ConsoleWrite(@LF)<br />
</syntaxhighlight><br />
<br />
== Arrays in Arrays ==<br />
<br />
You may save an array in an array element (item). Remember that there may be issues if you pass an array containing arrays into a function and the embedded array is changed inside that function. So, as a general rule, try not to embed arrays within arrays unless you absolutely need to and are prepared to do rigorous testing to make sure your code will always work as expected.<br />
<br />
You can access the elements of these embedded arrays directly (note the additional () required):<br />
<br />
<syntaxhighlight lang="autoit"><br />
Local $aContainerArray[2]<br />
Local $aInternalArray_0[2] = ["Internal-0-0","Internal-0-1"]<br />
Local $aInternalArray_1[2] = ["Internal-1-0","Internal-1-1"]<br />
$aContainerArray[0] = $aInternalArray_0<br />
$aContainerArray[1] = $aInternalArray_1<br />
<br />
ConsoleWrite("1 element of InternalArray_0: " & ($aContainerArray[0])[1] & @CRLF)<br />
ConsoleWrite("0 element of InternalArray_1: " & ($aContainerArray[1])[0] & @CRLF)<br />
</syntaxhighlight><br />
<br />
== More Information ==<br />
<br />
AutoIt features a large list of [http://www.autoitscript.com/autoit3/docs/libfunctions.htm User Defined Functions (UDF)], among which is a module supplying extra array functions. You can find a reference on those functions in AutoIt's Help file as the last main chapter named [http://www.autoitscript.com/autoit3/docs/libfunctions.htm User Defined Functions Reference].<br />
<br /><br />
<br /><br />
An associative array is an array where the keys (index numbers) are string instead of integer, as they are in AutoIt. See the [[Associative Arrays]] page for more information.<br />
[[Category:Tutorials]]</div>Skysnakehttps://www.autoitscript.com/w/index.php?title=Associative_Arrays&diff=13736Associative Arrays2017-11-30T10:58:37Z<p>Skysnake: </p>
<hr />
<div>In computer science, an associative array, map, symbol table, or dictionary is an abstract data type composed of a collection of (key, value) pairs, such that each possible key appears at most once in the collection.<br />
An associative array differs from a “normal” array in one major way: rather than being indexed numerically (i.e. 0, 1, 2, 3, …), it is indexed by a key, or a language-like word. <br />
A '''Scripting.Dictionary''' is a standard '''''object''''' provided by the '''Microsoft Scripting Runtime''' (scrrun.dll) dependency and is commonly used in VBScript, a reference to which needs to be added in order to create an object in your AutoIt project.<br />
<br /><br />
<br /><br />
This discussion by '''Nutster''' explains the [https://www.autoitscript.com/forum/topic/59174-associative-array-functions/#comment-445963 original implementation] of Associative Arrays in AutoIt. <br />
An associative array is an array where the keys (index numbers) are string instead of integer, as they are in AutoIt. Linux / Unix awk and perl use associative arrays by default. The following functions can be used to manage a version of associative arrays in single AutoIt variables. A hash table is used to store the values because it is faster to insert than other options I can think of and pretty much as fast as them to retrieve the data. The memory requirements are a little higher than other methods, but I think it is a reasonable trade-off. It uses a simple hash function that can probably be easily improved upon and while it can resize the hash table, the resize is slow so try to make your initial size large enough for all your elements. Please see the Include file and an exerciser that demonstrates how to use the associative array functions. Read the comments at the top of each function for more details on their use.<br />
<br /><br />
<br /><br />
<blockquote><br />
<big>Note:</big><br />
<br /><br />
AutoIt allows for at least two different implementations of Associative Arrays. The first method relies on a ''native'' AutoIt internal process handling named array elements, with no reference to the Scripting Dictionary. The second method relies on the Scripting Dictionary to create and manage associative arrays. <br />
</blockquote><br />
<br /><br />
<br />
<br /><br />
<br />
A few notes on Associative Arrays:<br /><br />
* Think of an associative array as an array with named elements<br />
* Comparisons can be exact (binary) or case insensitive (alpha)<br />
<br /><br /><br />
At the time of writing this - 28 November 2017 - a new '''map data type''' is under development for AutoIt. It is availabe in the current [https://www.autoitscript.com/forum/topic/163657-maps-beta/?do=findComment&comment=1296278 beta release].<br />
<br /><br />
<br /><br />
Please also see this entry in the Snippets section of this Wiki [https://www.autoitscript.com/wiki/Snippets_(_AutoIt_Array_)#AssocArray _AssocArray] <br />
<br /><br />
<br /><br />
<br />
A dictionary object example by [https://www.autoitscript.com/forum/profile/2709-mhz/ MHz]<br />
<syntaxhighlight lang='autoit'><br />
; Author Mhz<br />
; Forum https://www.autoitscript.com/forum/topic/182334-scripting-dictionary-modified/<br />
Global $vKey, $sItem, $sMsg, $oDictionary <br />
<br />
; Create dictionary object<br />
$oDictionary = ObjCreate("Scripting.Dictionary")<br />
<br />
If @error Then<br />
MsgBox(0, '', 'Error creating the dictionary object')<br />
Else<br />
; Add keys with items<br />
$oDictionary.Add ("One", "Same" )<br />
$oDictionary.Add ("Two", "Car" )<br />
$oDictionary.Add ("Three", "House" )<br />
$oDictionary.Add ("Four", "Boat" )<br />
<br />
If $oDictionary.Exists('One') Then<br />
; Display item<br />
MsgBox(0x0, 'Item One', $oDictionary.Item('One'), 2)<br />
; Set an item<br />
$oDictionary.Item('One') = 'Changed'<br />
; Display item<br />
MsgBox(0x20, 'Did Item One Change?', $oDictionary.Item('One'), 3)<br />
; Remove key<br />
$oDictionary.Remove('One')<br />
; <br />
$oDictionary.Key ('Two') = 'Bike'<br />
EndIf<br />
<br />
Sleep(1000)<br />
<br />
; Store items into a variable<br />
For $vKey In $oDictionary<br />
$sItem &= $oDictionary.Item($vKey) & @CRLF<br />
Next<br />
<br />
; Display items<br />
MsgBox(0x0, 'Items Count: ' & $oDictionary.Count, $sItem, 3)<br />
<br />
; Add items into an array<br />
$aItems = $oDictionary.Items<br />
<br />
; Display items in the array<br />
For $i = 0 To $oDictionary.Count -1<br />
MsgBox(0x0, 'Items [ ' & $i & ' ]', $aItems[$i], 2)<br />
Next<br />
<br />
Sleep(1000)<br />
<br />
; Add keys into an array<br />
$aKeys = $oDictionary.Keys<br />
<br />
; Display keys in the array<br />
For $i = 0 To $oDictionary.Count -1<br />
MsgBox(0x0, 'Keys [ ' & $i & ' ]', $aKeys[$i], 2)<br />
Next<br />
EndIf<br />
</syntaxhighlight><br />
<br /><br />
<br /><br />
The original AutoIt Scripting Dictionary implementation appears to have been by Gary Frost as far back as 2007. It has since been modified to the following:<br />
<br /><br />
<syntaxhighlight lang='autoit'><br />
#cs<br />
Scripting Dictionary UDF<br />
<br />
Made by GaryFrost <https://www.autoitscript.com/forum/topic/47048-scripting-dictionary/><br />
Modified by Jefrey <jefrey[at]jefrey.ml><br />
<br />
Forum https://www.autoitscript.com/forum/topic/182334-scripting-dictionary-modified/<br />
<br />
#ce<br />
<br />
Func _InitDictionary()<br />
Return ObjCreate("Scripting.Dictionary")<br />
EndFunc ;==>_InitDictionary<br />
<br />
; Adds a key and item pair to a Dictionary object.<br />
Func _AddItem($oDictionary, $v_key, $v_item)<br />
$oDictionary.ADD($v_key, $v_item)<br />
If @error Then Return SetError(1, 1, -1)<br />
EndFunc ;==>_AddItem<br />
<br />
; Returns true if a specified key exists in the Dictionary object, false if it does not.<br />
Func _ItemExists($oDictionary, $v_key)<br />
Return $oDictionary.Exists($v_key)<br />
EndFunc ;==>_ItemExists<br />
<br />
; Returns an item for a specified key in a Dictionary object<br />
Func _Item($oDictionary, $v_key)<br />
Return $oDictionary.Item($v_key)<br />
EndFunc ;==>_Item<br />
<br />
; Sets an item for a specified key in a Dictionary object<br />
Func _ChangeItem($oDictionary, $v_key, $v_item)<br />
$oDictionary.Item($v_key) = $v_item<br />
EndFunc ;==>_ChangeItem<br />
<br />
; Sets a key in a Dictionary object.<br />
Func _ChangeKey($oDictionary, $v_key, $v_newKey)<br />
$oDictionary.Key($v_key) = $v_newKey<br />
EndFunc ;==>_ChangeKey<br />
<br />
; Removes a key, item pair from a Dictionary object.<br />
Func _ItemRemove($oDictionary, $v_key)<br />
$oDictionary.Remove($v_key)<br />
If @error Then Return SetError(1, 1, -1)<br />
EndFunc ;==>_ItemRemove<br />
<br />
; Returns the number of items in a collection or Dictionary object.<br />
Func _ItemCount($oDictionary)<br />
Return $oDictionary.Count<br />
EndFunc ;==>_ItemCount<br />
<br />
; Returns an array containing all the items in a Dictionary object<br />
Func _GetItems($oDictionary)<br />
Return $oDictionary.Items<br />
EndFunc ;==>_GetItems<br />
<br />
Func _Clear($oDictionary)<br />
Return $oDictionary.RemoveAll<br />
EndFunc<br />
<br />
</syntaxhighlight><br />
<br /><br />
<br /><br />
Below are several examples that illustrate the usage of the Scripting Dictionary UDF in AutoIt.<br />
<br /><br />
Example 1:<br />
<syntaxhighlight lang='autoit'><br />
; Author Jefrey<br />
; Forum https://www.autoitscript.com/forum/profile/75137-jefrey/<br />
#include 'scriptingdic.au3'<br />
#include <Array.au3> ; Needed only for _ArrayDisplay, and not required by the lib<br />
<br />
; Init the object<br />
$oObj = _InitDictionary()<br />
<br />
; Adding a single value<br />
_AddItem($oObj, 0, "Test")<br />
; And showing it<br />
msgbox(0, '', _Item($oObj, 0))<br />
<br />
; Adding an array<br />
Dim $aArr[] = [0, -80, -49, -44, 80, 100, 8, 7, 6, 5, 4, 3, 2, 1]<br />
_AddItem($oObj, 1, $aArr)<br />
; And showing it<br />
_ArrayDisplay(_Item($oObj, 1))<br />
<br />
; We can also use this approach:<br />
$oObj3 = _InitDictionary()<br />
$oObj.Add("test", "foo")<br />
MsgBox(0, '', $oObj.Item("test"))<br />
</syntaxhighlight><br />
Example 2 is a reply to a common question asked on the Forum, How to find duplicate lines/values... <br />
<syntaxhighlight lang='autoit'><br />
; Author Malkey <br />
; https://www.autoitscript.com/forum/profile/31256-malkey/<br />
; Forum https://www.autoitscript.com/forum/topic/116156-best-way-to-compare-strings-for-duplicates/?do=findComment&comment=810752<br />
Local $sStr, $begin, $dif, $sMatches<br />
<br />
; Create random test data<br />
For $i = 1 To 1000<br />
$sStr &= Chr(Random(Asc("a"), Asc("z"), 1)) & Chr(Random(Asc("a"), Asc("z"), 1)) & _<br />
Chr(Random(Asc("a"), Asc("z"), 1)) & Chr(Random(Asc("a"), Asc("z"), 1)) & @CRLF ;<br />
Next<br />
;ConsoleWrite($sStr & @CRLF)<br />
<br />
$begin = TimerInit()<br />
<br />
Local $oDict = ObjCreate("Scripting.Dictionary") ; to create a dictionary object<br />
Local $aArray = StringSplit(StringStripWS($sStr, 2), @CRLF, 3)<br />
For $i = 0 To UBound($aArray) - 1<br />
If $oDict.Exists($aArray[$i]) Then<br />
$sMatches &= $i & " " & $aArray[$i] & @CRLF ; Record duplicates<br />
Else<br />
$oDict.add($aArray[$i], '') ; to store a string (you may set $value = '' if you have no use of it)<br />
EndIf<br />
Next<br />
$dif = Round(TimerDiff($begin) / 1000, 3) & " secs"<br />
<br />
;Display results<br />
If $sMatches <> "" Then<br />
MsgBox(0, "Results", StringTrimRight($sMatches, 2) & @CRLF & "Time taken = " & $dif)<br />
Else<br />
MsgBox(0, "Results", "No duplicates found" & @CRLF & "Time taken = " & $dif)<br />
EndIf<br />
</syntaxhighlight><br />
<br /><br />
<br /><br /><br />
__________________________________________________________________________<br />
<br /><br />
While the examples above use the Scripting Dictionary method, the example below by guinness does not use the Scripting Dictionary. Also see [https://www.autoitscript.com/forum/topic/59174-associative-array-functions/ this discussion] by Nutster, with Associative Array management tools. <br />
<br />
The next example does not use the scripting dictionary UDF, but makes use of Global Enumerators. This allows access to data through named elements and uses an ''Object Oriented Programming''-like approach to encapsulate data.<br />
<syntaxhighlight lang='autoit'><br />
; Author guinness<br />
; Forum https://www.autoitscript.com/forum/topic/173803-oop-like-approach-in-autoit/<br />
#include <MsgBoxConstants.au3><br />
<br />
; ---- Start of Person Class<br />
<br />
; Stored in the 'object' to verify it's our 'object' and not some random array<br />
Global Const $PERSON_GUID = '4197B285-6AB1-489B-8585-08C852E33F3D'<br />
<br />
; Friendly names for 0, 1, 2 and 3<br />
Global Enum $PERSON_AGE, $PERSON_NAME, $PERSON_ID, $PERSON_MAX<br />
<br />
; Constructor<br />
Func Person($sName, $iAge)<br />
Local $hPerson[$PERSON_MAX]<br />
<br />
; Set the GUID, so as the verification will work<br />
$hPerson[$PERSON_ID] = $PERSON_GUID<br />
<br />
Person_SetAge($hPerson, $iAge)<br />
Person_SetName($hPerson, $sName)<br />
<br />
; Return the Person 'object'<br />
Return $hPerson<br />
EndFunc ;==>Person<br />
<br />
; Getter for the age property<br />
Func Person_GetAge(ByRef $hPerson)<br />
Return _Person_IsObject($hPerson) ? $hPerson[$PERSON_AGE] : Null<br />
EndFunc ;==>Person_GetAge<br />
<br />
; Setter for the age property<br />
Func Person_SetAge(ByRef $hPerson, $iAge)<br />
; If not a valid 'object' or integer then return<br />
If Not _Person_IsObject($hPerson) Or Not IsInt($iAge) Then Return<br />
<br />
; Set the age<br />
$hPerson[$PERSON_AGE] = $iAge<br />
EndFunc ;==>Person_SetAge<br />
<br />
; Getter for the name property<br />
Func Person_GetName(ByRef $hPerson)<br />
Return _Person_IsObject($hPerson) ? $hPerson[$PERSON_NAME] : Null<br />
EndFunc ;==>Person_GetName<br />
<br />
; Setter for the name property<br />
Func Person_SetName(ByRef $hPerson, $sName)<br />
; If not a valid 'object' then return<br />
If Not _Person_IsObject($hPerson) Then Return<br />
<br />
; Set the name<br />
$hPerson[$PERSON_NAME] = $sName<br />
EndFunc ;==>Person_SetName<br />
<br />
; ToString() for the 'object'<br />
Func Person_ToString(ByRef $hPerson)<br />
Return _Person_IsObject($hPerson) ? StringFormat('Name: %s, Age: %i', $hPerson[$PERSON_NAME], $hPerson[$PERSON_AGE]) : Null<br />
EndFunc ;==>Person_ToString<br />
<br />
; Check if it's a valid 'object' and not some random array. "NTERNAL ONLY!<br />
Func _Person_IsObject(ByRef $hPerson)<br />
Return UBound($hPerson) = $PERSON_MAX And $hPerson[$PERSON_ID] == $PERSON_GUID<br />
EndFunc ;==>_Person_IsObject<br />
<br />
; ---- End of Person Class<br />
<br />
Example()<br />
<br />
Func Example()<br />
; Store the Person 'object', which is just a glorified array<br />
Local $hP1 = Person('John', 30)<br />
<br />
; Display the 'object'<br />
MsgBox($MB_SYSTEMMODAL, 'Person 1', Person_ToString($hP1))<br />
<br />
; Create a new person<br />
<br />
; Store the Person 'object', which is just a glorified array<br />
Local $hP2 = Person('James', 36)<br />
<br />
; Display the 'object'<br />
MsgBox($MB_SYSTEMMODAL, 'Person 2', Person_ToString($hP2))<br />
<br />
; Set the age for Person 2<br />
Person_SetAge($hP2, 45)<br />
<br />
; Display the 'object'<br />
MsgBox($MB_SYSTEMMODAL, 'Person 2 - Revised', Person_ToString($hP2))<br />
EndFunc ;==>Example<br />
</syntaxhighlight><br />
Please see the current beta for more information on map functions.<br />
<syntaxhighlight lang='autoit'><br />
</syntaxhighlight></div>Skysnakehttps://www.autoitscript.com/w/index.php?title=Associative_Arrays&diff=13735Associative Arrays2017-11-30T10:57:42Z<p>Skysnake: </p>
<hr />
<div>In computer science, an associative array, map, symbol table, or dictionary is an abstract data type composed of a collection of (key, value) pairs, such that each possible key appears at most once in the collection.<br />
An associative array differs from a “normal” array in one major way: rather than being indexed numerically (i.e. 0, 1, 2, 3, …), it is indexed by a key, or a language-like word. <br />
A '''Scripting.Dictionary''' is a standard '''''object''''' provided by the '''Microsoft Scripting Runtime''' (scrrun.dll) dependency and is commonly used in VBScript, a reference to which needs to be added in order to create an object in your AutoIt project.<br />
<br /><br />
<br /><br />
This discussion by '''Nutster''' explains the [https://www.autoitscript.com/forum/topic/59174-associative-array-functions/#comment-445963 original implementation] of Associative Arrays in AutoIt. <br />
An associative array is an array where the keys (index numbers) are string instead of integer, as they are in AutoIt. Linux / Unix awk and perl use associative arrays by default. The following functions can be used to manage a version of associative arrays in single AutoIt variables. A hash table is used to store the values because it is faster to insert than other options I can think of and pretty much as fast as them to retrieve the data. The memory requirements are a little higher than other methods, but I think it is a reasonable trade-off. It uses a simple hash function that can probably be easily improved upon and while it can resize the hash table, the resize is slow so try to make your initial size large enough for all your elements. Please see the Include file and an exerciser that demonstrates how to use the associative array functions. Read the comments at the top of each function for more details on their use.<br />
<br /><br />
<br /><br />
<blockquote><br />
<big>Note:</big><br />
<br /><br />
AutoIt allows for at least two different implementations of Associative Arrays. The first method relies on a ''native'' AutoIt internal process handling named array elements, with no reference to the Scripting Dictionary. The second method relies on the Scripting Dictionary to create and manage associative arrays. <br />
</blockquote><br />
<br /><br />
<br />
<br /><br />
<br />
A few notes on Associative Arrays:<br /><br />
* Think of an associative array as an array with named elements<br />
* Comparisons can be exact (binary) or case insensitive (alpha)<br />
<br /><br /><br />
At the time of writing this - 28 November 2017 - a new '''map data type''' is under development for AutoIt. It is availabe in the current [https://www.autoitscript.com/forum/topic/163657-maps-beta/?do=findComment&comment=1296278 beta release].<br />
<br /><br />
<br /><br />
Please also see this entry in the Snippets section of this Wiki [https://www.autoitscript.com/wiki/Snippets_(_AutoIt_Array_)#AssocArray _AssocArray] <br />
<br /><br />
<br /><br />
<br />
A dictionary object example by [https://www.autoitscript.com/forum/profile/2709-mhz/ MHz]<br />
<syntaxhighlight lang='autoit'><br />
; Author Mhz<br />
; Forum https://www.autoitscript.com/forum/topic/182334-scripting-dictionary-modified/<br />
Global $vKey, $sItem, $sMsg, $oDictionary <br />
<br />
; Create dictionary object<br />
$oDictionary = ObjCreate("Scripting.Dictionary")<br />
<br />
If @error Then<br />
MsgBox(0, '', 'Error creating the dictionary object')<br />
Else<br />
; Add keys with items<br />
$oDictionary.Add ("One", "Same" )<br />
$oDictionary.Add ("Two", "Car" )<br />
$oDictionary.Add ("Three", "House" )<br />
$oDictionary.Add ("Four", "Boat" )<br />
<br />
If $oDictionary.Exists('One') Then<br />
; Display item<br />
MsgBox(0x0, 'Item One', $oDictionary.Item('One'), 2)<br />
; Set an item<br />
$oDictionary.Item('One') = 'Changed'<br />
; Display item<br />
MsgBox(0x20, 'Did Item One Change?', $oDictionary.Item('One'), 3)<br />
; Remove key<br />
$oDictionary.Remove('One')<br />
; <br />
$oDictionary.Key ('Two') = 'Bike'<br />
EndIf<br />
<br />
Sleep(1000)<br />
<br />
; Store items into a variable<br />
For $vKey In $oDictionary<br />
$sItem &= $oDictionary.Item($vKey) & @CRLF<br />
Next<br />
<br />
; Display items<br />
MsgBox(0x0, 'Items Count: ' & $oDictionary.Count, $sItem, 3)<br />
<br />
; Add items into an array<br />
$aItems = $oDictionary.Items<br />
<br />
; Display items in the array<br />
For $i = 0 To $oDictionary.Count -1<br />
MsgBox(0x0, 'Items [ ' & $i & ' ]', $aItems[$i], 2)<br />
Next<br />
<br />
Sleep(1000)<br />
<br />
; Add keys into an array<br />
$aKeys = $oDictionary.Keys<br />
<br />
; Display keys in the array<br />
For $i = 0 To $oDictionary.Count -1<br />
MsgBox(0x0, 'Keys [ ' & $i & ' ]', $aKeys[$i], 2)<br />
Next<br />
EndIf<br />
</syntaxhighlight><br />
<br /><br />
<br /><br />
The original AutoIt Scripting Dictionary implementation appears to have been by Gary Frost as far back as 2007. It has since been modified to the following:<br />
<br /><br />
<syntaxhighlight lang='autoit'><br />
#cs<br />
Scripting Dictionary UDF<br />
<br />
Made by GaryFrost <https://www.autoitscript.com/forum/topic/47048-scripting-dictionary/><br />
Modified by Jefrey <jefrey[at]jefrey.ml><br />
<br />
Forum https://www.autoitscript.com/forum/topic/182334-scripting-dictionary-modified/<br />
<br />
#ce<br />
<br />
Func _InitDictionary()<br />
Return ObjCreate("Scripting.Dictionary")<br />
EndFunc ;==>_InitDictionary<br />
<br />
; Adds a key and item pair to a Dictionary object.<br />
Func _AddItem($oDictionary, $v_key, $v_item)<br />
$oDictionary.ADD($v_key, $v_item)<br />
If @error Then Return SetError(1, 1, -1)<br />
EndFunc ;==>_AddItem<br />
<br />
; Returns true if a specified key exists in the Dictionary object, false if it does not.<br />
Func _ItemExists($oDictionary, $v_key)<br />
Return $oDictionary.Exists($v_key)<br />
EndFunc ;==>_ItemExists<br />
<br />
; Returns an item for a specified key in a Dictionary object<br />
Func _Item($oDictionary, $v_key)<br />
Return $oDictionary.Item($v_key)<br />
EndFunc ;==>_Item<br />
<br />
; Sets an item for a specified key in a Dictionary object<br />
Func _ChangeItem($oDictionary, $v_key, $v_item)<br />
$oDictionary.Item($v_key) = $v_item<br />
EndFunc ;==>_ChangeItem<br />
<br />
; Sets a key in a Dictionary object.<br />
Func _ChangeKey($oDictionary, $v_key, $v_newKey)<br />
$oDictionary.Key($v_key) = $v_newKey<br />
EndFunc ;==>_ChangeKey<br />
<br />
; Removes a key, item pair from a Dictionary object.<br />
Func _ItemRemove($oDictionary, $v_key)<br />
$oDictionary.Remove($v_key)<br />
If @error Then Return SetError(1, 1, -1)<br />
EndFunc ;==>_ItemRemove<br />
<br />
; Returns the number of items in a collection or Dictionary object.<br />
Func _ItemCount($oDictionary)<br />
Return $oDictionary.Count<br />
EndFunc ;==>_ItemCount<br />
<br />
; Returns an array containing all the items in a Dictionary object<br />
Func _GetItems($oDictionary)<br />
Return $oDictionary.Items<br />
EndFunc ;==>_GetItems<br />
<br />
Func _Clear($oDictionary)<br />
Return $oDictionary.RemoveAll<br />
EndFunc<br />
<br />
</syntaxhighlight><br />
<br /><br />
<br /><br />
Below are several examples that illustrate the usage of the Scripting Dictionary UDF in AutoIt.<br />
<br /><br />
Example 1:<br />
<syntaxhighlight lang='autoit'><br />
; Author Jefrey<br />
; Forum https://www.autoitscript.com/forum/profile/75137-jefrey/<br />
#include 'scriptingdic.au3'<br />
#include <Array.au3> ; Needed only for _ArrayDisplay, and not required by the lib<br />
<br />
; Init the object<br />
$oObj = _InitDictionary()<br />
<br />
; Adding a single value<br />
_AddItem($oObj, 0, "Test")<br />
; And showing it<br />
msgbox(0, '', _Item($oObj, 0))<br />
<br />
; Adding an array<br />
Dim $aArr[] = [0, -80, -49, -44, 80, 100, 8, 7, 6, 5, 4, 3, 2, 1]<br />
_AddItem($oObj, 1, $aArr)<br />
; And showing it<br />
_ArrayDisplay(_Item($oObj, 1))<br />
<br />
; We can also use this approach:<br />
$oObj3 = _InitDictionary()<br />
$oObj.Add("test", "foo")<br />
MsgBox(0, '', $oObj.Item("test"))<br />
</syntaxhighlight><br />
Example 2 is a reply to a common question asked on the Forum, How to find duplicate lines/values... <br />
<syntaxhighlight lang='autoit'><br />
; Author Malkey <br />
; https://www.autoitscript.com/forum/profile/31256-malkey/<br />
; Forum https://www.autoitscript.com/forum/topic/116156-best-way-to-compare-strings-for-duplicates/?do=findComment&comment=810752<br />
Local $sStr, $begin, $dif, $sMatches<br />
<br />
; Create random test data<br />
For $i = 1 To 1000<br />
$sStr &= Chr(Random(Asc("a"), Asc("z"), 1)) & Chr(Random(Asc("a"), Asc("z"), 1)) & _<br />
Chr(Random(Asc("a"), Asc("z"), 1)) & Chr(Random(Asc("a"), Asc("z"), 1)) & @CRLF ;<br />
Next<br />
;ConsoleWrite($sStr & @CRLF)<br />
<br />
$begin = TimerInit()<br />
<br />
Local $oDict = ObjCreate("Scripting.Dictionary") ; to create a dictionary object<br />
Local $aArray = StringSplit(StringStripWS($sStr, 2), @CRLF, 3)<br />
For $i = 0 To UBound($aArray) - 1<br />
If $oDict.Exists($aArray[$i]) Then<br />
$sMatches &= $i & " " & $aArray[$i] & @CRLF ; Record duplicates<br />
Else<br />
$oDict.add($aArray[$i], '') ; to store a string (you may set $value = '' if you have no use of it)<br />
EndIf<br />
Next<br />
$dif = Round(TimerDiff($begin) / 1000, 3) & " secs"<br />
<br />
;Display results<br />
If $sMatches <> "" Then<br />
MsgBox(0, "Results", StringTrimRight($sMatches, 2) & @CRLF & "Time taken = " & $dif)<br />
Else<br />
MsgBox(0, "Results", "No duplicates found" & @CRLF & "Time taken = " & $dif)<br />
EndIf<br />
</syntaxhighlight><br />
<br /><br />
<br /><br /><br />
__________________________________________________________________________<br />
<br /><br />
While the examples above use the Scripting Dictionary method, the example below by guinness does not use the Scripting Dictionary. Also see [https://www.autoitscript.com/forum/topic/59174-associative-array-functions/ this discussion] by Nutster, with Associative Array management tools. <br />
<br />
The next example does not use the scripting dictionary UDF, but makes use of Global Enumerators. This allows access to data through named elements and uses an Object Oriented Programming approach to encapsulate data.<br />
<syntaxhighlight lang='autoit'><br />
; Author guinness<br />
; Forum https://www.autoitscript.com/forum/topic/173803-oop-like-approach-in-autoit/<br />
#include <MsgBoxConstants.au3><br />
<br />
; ---- Start of Person Class<br />
<br />
; Stored in the 'object' to verify it's our 'object' and not some random array<br />
Global Const $PERSON_GUID = '4197B285-6AB1-489B-8585-08C852E33F3D'<br />
<br />
; Friendly names for 0, 1, 2 and 3<br />
Global Enum $PERSON_AGE, $PERSON_NAME, $PERSON_ID, $PERSON_MAX<br />
<br />
; Constructor<br />
Func Person($sName, $iAge)<br />
Local $hPerson[$PERSON_MAX]<br />
<br />
; Set the GUID, so as the verification will work<br />
$hPerson[$PERSON_ID] = $PERSON_GUID<br />
<br />
Person_SetAge($hPerson, $iAge)<br />
Person_SetName($hPerson, $sName)<br />
<br />
; Return the Person 'object'<br />
Return $hPerson<br />
EndFunc ;==>Person<br />
<br />
; Getter for the age property<br />
Func Person_GetAge(ByRef $hPerson)<br />
Return _Person_IsObject($hPerson) ? $hPerson[$PERSON_AGE] : Null<br />
EndFunc ;==>Person_GetAge<br />
<br />
; Setter for the age property<br />
Func Person_SetAge(ByRef $hPerson, $iAge)<br />
; If not a valid 'object' or integer then return<br />
If Not _Person_IsObject($hPerson) Or Not IsInt($iAge) Then Return<br />
<br />
; Set the age<br />
$hPerson[$PERSON_AGE] = $iAge<br />
EndFunc ;==>Person_SetAge<br />
<br />
; Getter for the name property<br />
Func Person_GetName(ByRef $hPerson)<br />
Return _Person_IsObject($hPerson) ? $hPerson[$PERSON_NAME] : Null<br />
EndFunc ;==>Person_GetName<br />
<br />
; Setter for the name property<br />
Func Person_SetName(ByRef $hPerson, $sName)<br />
; If not a valid 'object' then return<br />
If Not _Person_IsObject($hPerson) Then Return<br />
<br />
; Set the name<br />
$hPerson[$PERSON_NAME] = $sName<br />
EndFunc ;==>Person_SetName<br />
<br />
; ToString() for the 'object'<br />
Func Person_ToString(ByRef $hPerson)<br />
Return _Person_IsObject($hPerson) ? StringFormat('Name: %s, Age: %i', $hPerson[$PERSON_NAME], $hPerson[$PERSON_AGE]) : Null<br />
EndFunc ;==>Person_ToString<br />
<br />
; Check if it's a valid 'object' and not some random array. "NTERNAL ONLY!<br />
Func _Person_IsObject(ByRef $hPerson)<br />
Return UBound($hPerson) = $PERSON_MAX And $hPerson[$PERSON_ID] == $PERSON_GUID<br />
EndFunc ;==>_Person_IsObject<br />
<br />
; ---- End of Person Class<br />
<br />
Example()<br />
<br />
Func Example()<br />
; Store the Person 'object', which is just a glorified array<br />
Local $hP1 = Person('John', 30)<br />
<br />
; Display the 'object'<br />
MsgBox($MB_SYSTEMMODAL, 'Person 1', Person_ToString($hP1))<br />
<br />
; Create a new person<br />
<br />
; Store the Person 'object', which is just a glorified array<br />
Local $hP2 = Person('James', 36)<br />
<br />
; Display the 'object'<br />
MsgBox($MB_SYSTEMMODAL, 'Person 2', Person_ToString($hP2))<br />
<br />
; Set the age for Person 2<br />
Person_SetAge($hP2, 45)<br />
<br />
; Display the 'object'<br />
MsgBox($MB_SYSTEMMODAL, 'Person 2 - Revised', Person_ToString($hP2))<br />
EndFunc ;==>Example<br />
</syntaxhighlight><br />
Please see the current beta for more information on map functions.<br />
<syntaxhighlight lang='autoit'><br />
</syntaxhighlight></div>Skysnakehttps://www.autoitscript.com/w/index.php?title=Associative_Arrays&diff=13734Associative Arrays2017-11-30T10:48:24Z<p>Skysnake: </p>
<hr />
<div>In computer science, an associative array, map, symbol table, or dictionary is an abstract data type composed of a collection of (key, value) pairs, such that each possible key appears at most once in the collection.<br />
An associative array differs from a “normal” array in one major way: rather than being indexed numerically (i.e. 0, 1, 2, 3, …), it is indexed by a key, or a language-like word. <br />
A '''Scripting.Dictionary''' is a standard '''''object''''' provided by the '''Microsoft Scripting Runtime''' (scrrun.dll) dependency and is commonly used in VBScript, a reference to which needs to be added in order to create an object in your AutoIt project.<br />
<br /><br />
<br /><br />
This discussion by '''Nutster''' explains the [https://www.autoitscript.com/forum/topic/59174-associative-array-functions/#comment-445963 original implementation] of Associative Arrays in AutoIt. <br />
An associative array is an array where the keys (index numbers) are string instead of integer, as they are in AutoIt. Linux / Unix awk and perl use associative arrays by default. The following functions can be used to manage a version of associative arrays in single AutoIt variables. A hash table is used to store the values because it is faster to insert than other options I can think of and pretty much as fast as them to retrieve the data. The memory requirements are a little higher than other methods, but I think it is a reasonable trade-off. It uses a simple hash function that can probably be easily improved upon and while it can resize the hash table, the resize is slow so try to make your initial size large enough for all your elements. Please see the Include file and an exerciser that demonstrates how to use the associative array functions. Read the comments at the top of each function for more details on their use.<br />
<br /><br />
<br /><br />
<blockquote><br />
<big>Note:</big><br />
<br /><br />
AutoIt allows for at least two different implementations of Associative Arrays. The first method relies on a ''native'' AutoIt internal process handling named array elements, with no reference to the Scripting Dictionary. The second method relies on the Scripting Dictionary to create and manage associative arrays. <br />
</blockquote><br />
<br /><br />
<br />
<br /><br />
<br />
A few notes on Associative Arrays:<br /><br />
* Think of an associative array as an array with named elements<br />
* Comparisons can be exact (binary) or case insensitive (alpha)<br />
<br /><br /><br />
At the time of writing this - 28 November 2017 - a new '''map data type''' is under development for AutoIt. It is availabe in the current [https://www.autoitscript.com/forum/topic/163657-maps-beta/?do=findComment&comment=1296278 beta release].<br />
<br /><br />
<br /><br />
Please also see this entry in the Snippets section of this Wiki [https://www.autoitscript.com/wiki/Snippets_(_AutoIt_Array_)#AssocArray _AssocArray] <br />
<br /><br />
<br /><br />
<br />
A dictionary object example by [https://www.autoitscript.com/forum/profile/2709-mhz/ MHz]<br />
<syntaxhighlight lang='autoit'><br />
; Author Mhz<br />
; Forum https://www.autoitscript.com/forum/topic/182334-scripting-dictionary-modified/<br />
Global $vKey, $sItem, $sMsg, $oDictionary <br />
<br />
; Create dictionary object<br />
$oDictionary = ObjCreate("Scripting.Dictionary")<br />
<br />
If @error Then<br />
MsgBox(0, '', 'Error creating the dictionary object')<br />
Else<br />
; Add keys with items<br />
$oDictionary.Add ("One", "Same" )<br />
$oDictionary.Add ("Two", "Car" )<br />
$oDictionary.Add ("Three", "House" )<br />
$oDictionary.Add ("Four", "Boat" )<br />
<br />
If $oDictionary.Exists('One') Then<br />
; Display item<br />
MsgBox(0x0, 'Item One', $oDictionary.Item('One'), 2)<br />
; Set an item<br />
$oDictionary.Item('One') = 'Changed'<br />
; Display item<br />
MsgBox(0x20, 'Did Item One Change?', $oDictionary.Item('One'), 3)<br />
; Remove key<br />
$oDictionary.Remove('One')<br />
; <br />
$oDictionary.Key ('Two') = 'Bike'<br />
EndIf<br />
<br />
Sleep(1000)<br />
<br />
; Store items into a variable<br />
For $vKey In $oDictionary<br />
$sItem &= $oDictionary.Item($vKey) & @CRLF<br />
Next<br />
<br />
; Display items<br />
MsgBox(0x0, 'Items Count: ' & $oDictionary.Count, $sItem, 3)<br />
<br />
; Add items into an array<br />
$aItems = $oDictionary.Items<br />
<br />
; Display items in the array<br />
For $i = 0 To $oDictionary.Count -1<br />
MsgBox(0x0, 'Items [ ' & $i & ' ]', $aItems[$i], 2)<br />
Next<br />
<br />
Sleep(1000)<br />
<br />
; Add keys into an array<br />
$aKeys = $oDictionary.Keys<br />
<br />
; Display keys in the array<br />
For $i = 0 To $oDictionary.Count -1<br />
MsgBox(0x0, 'Keys [ ' & $i & ' ]', $aKeys[$i], 2)<br />
Next<br />
EndIf<br />
</syntaxhighlight><br />
<br /><br />
<br /><br />
The original AutoIt Scripting Dictionary implementation appears to have been by Gary Frost as far back as 2007. It has since been modified to the following:<br />
<br /><br />
<syntaxhighlight lang='autoit'><br />
#cs<br />
Scripting Dictionary UDF<br />
<br />
Made by GaryFrost <https://www.autoitscript.com/forum/topic/47048-scripting-dictionary/><br />
Modified by Jefrey <jefrey[at]jefrey.ml><br />
<br />
Forum https://www.autoitscript.com/forum/topic/182334-scripting-dictionary-modified/<br />
<br />
#ce<br />
<br />
Func _InitDictionary()<br />
Return ObjCreate("Scripting.Dictionary")<br />
EndFunc ;==>_InitDictionary<br />
<br />
; Adds a key and item pair to a Dictionary object.<br />
Func _AddItem($oDictionary, $v_key, $v_item)<br />
$oDictionary.ADD($v_key, $v_item)<br />
If @error Then Return SetError(1, 1, -1)<br />
EndFunc ;==>_AddItem<br />
<br />
; Returns true if a specified key exists in the Dictionary object, false if it does not.<br />
Func _ItemExists($oDictionary, $v_key)<br />
Return $oDictionary.Exists($v_key)<br />
EndFunc ;==>_ItemExists<br />
<br />
; Returns an item for a specified key in a Dictionary object<br />
Func _Item($oDictionary, $v_key)<br />
Return $oDictionary.Item($v_key)<br />
EndFunc ;==>_Item<br />
<br />
; Sets an item for a specified key in a Dictionary object<br />
Func _ChangeItem($oDictionary, $v_key, $v_item)<br />
$oDictionary.Item($v_key) = $v_item<br />
EndFunc ;==>_ChangeItem<br />
<br />
; Sets a key in a Dictionary object.<br />
Func _ChangeKey($oDictionary, $v_key, $v_newKey)<br />
$oDictionary.Key($v_key) = $v_newKey<br />
EndFunc ;==>_ChangeKey<br />
<br />
; Removes a key, item pair from a Dictionary object.<br />
Func _ItemRemove($oDictionary, $v_key)<br />
$oDictionary.Remove($v_key)<br />
If @error Then Return SetError(1, 1, -1)<br />
EndFunc ;==>_ItemRemove<br />
<br />
; Returns the number of items in a collection or Dictionary object.<br />
Func _ItemCount($oDictionary)<br />
Return $oDictionary.Count<br />
EndFunc ;==>_ItemCount<br />
<br />
; Returns an array containing all the items in a Dictionary object<br />
Func _GetItems($oDictionary)<br />
Return $oDictionary.Items<br />
EndFunc ;==>_GetItems<br />
<br />
Func _Clear($oDictionary)<br />
Return $oDictionary.RemoveAll<br />
EndFunc<br />
<br />
</syntaxhighlight><br />
<br /><br />
<br /><br />
Below are several examples that illustrate the usage of the Scripting Dictionary UDF in AutoIt.<br />
<br /><br />
Example 1:<br />
<syntaxhighlight lang='autoit'><br />
; Author Jefrey<br />
; Forum https://www.autoitscript.com/forum/profile/75137-jefrey/<br />
#include 'scriptingdic.au3'<br />
#include <Array.au3> ; Needed only for _ArrayDisplay, and not required by the lib<br />
<br />
; Init the object<br />
$oObj = _InitDictionary()<br />
<br />
; Adding a single value<br />
_AddItem($oObj, 0, "Test")<br />
; And showing it<br />
msgbox(0, '', _Item($oObj, 0))<br />
<br />
; Adding an array<br />
Dim $aArr[] = [0, -80, -49, -44, 80, 100, 8, 7, 6, 5, 4, 3, 2, 1]<br />
_AddItem($oObj, 1, $aArr)<br />
; And showing it<br />
_ArrayDisplay(_Item($oObj, 1))<br />
<br />
; We can also use this approach:<br />
$oObj3 = _InitDictionary()<br />
$oObj.Add("test", "foo")<br />
MsgBox(0, '', $oObj.Item("test"))<br />
</syntaxhighlight><br />
Example 2 is a reply to a common question asked on the Forum, How to find duplicate lines/values... <br />
<syntaxhighlight lang='autoit'><br />
; Author Malkey <br />
; https://www.autoitscript.com/forum/profile/31256-malkey/<br />
; Forum https://www.autoitscript.com/forum/topic/116156-best-way-to-compare-strings-for-duplicates/?do=findComment&comment=810752<br />
Local $sStr, $begin, $dif, $sMatches<br />
<br />
; Create random test data<br />
For $i = 1 To 1000<br />
$sStr &= Chr(Random(Asc("a"), Asc("z"), 1)) & Chr(Random(Asc("a"), Asc("z"), 1)) & _<br />
Chr(Random(Asc("a"), Asc("z"), 1)) & Chr(Random(Asc("a"), Asc("z"), 1)) & @CRLF ;<br />
Next<br />
;ConsoleWrite($sStr & @CRLF)<br />
<br />
$begin = TimerInit()<br />
<br />
Local $oDict = ObjCreate("Scripting.Dictionary") ; to create a dictionary object<br />
Local $aArray = StringSplit(StringStripWS($sStr, 2), @CRLF, 3)<br />
For $i = 0 To UBound($aArray) - 1<br />
If $oDict.Exists($aArray[$i]) Then<br />
$sMatches &= $i & " " & $aArray[$i] & @CRLF ; Record duplicates<br />
Else<br />
$oDict.add($aArray[$i], '') ; to store a string (you may set $value = '' if you have no use of it)<br />
EndIf<br />
Next<br />
$dif = Round(TimerDiff($begin) / 1000, 3) & " secs"<br />
<br />
;Display results<br />
If $sMatches <> "" Then<br />
MsgBox(0, "Results", StringTrimRight($sMatches, 2) & @CRLF & "Time taken = " & $dif)<br />
Else<br />
MsgBox(0, "Results", "No duplicates found" & @CRLF & "Time taken = " & $dif)<br />
EndIf<br />
</syntaxhighlight><br />
<br /><br />
<br /><br /><br />
__________________________________________________________________________<br />
<br /><br />
While the examples above use the Scripting Dictionary method, the example below by guinness does not use the Scripting Dictionary. Also see [https://www.autoitscript.com/forum/topic/59174-associative-array-functions/ this discussion] by Nutster, with Associative Array management tools. <br />
<br />
The next example does not use the scripting dictionary UDF, but makes use of Global Enumerators. This allows access to data through named elements.<br />
<syntaxhighlight lang='autoit'><br />
; Author guinness<br />
; Forum https://www.autoitscript.com/forum/topic/173803-oop-like-approach-in-autoit/<br />
#include <MsgBoxConstants.au3><br />
<br />
; ---- Start of Person Class<br />
<br />
; Stored in the 'object' to verify it's our 'object' and not some random array<br />
Global Const $PERSON_GUID = '4197B285-6AB1-489B-8585-08C852E33F3D'<br />
<br />
; Friendly names for 0, 1, 2 and 3<br />
Global Enum $PERSON_AGE, $PERSON_NAME, $PERSON_ID, $PERSON_MAX<br />
<br />
; Constructor<br />
Func Person($sName, $iAge)<br />
Local $hPerson[$PERSON_MAX]<br />
<br />
; Set the GUID, so as the verification will work<br />
$hPerson[$PERSON_ID] = $PERSON_GUID<br />
<br />
Person_SetAge($hPerson, $iAge)<br />
Person_SetName($hPerson, $sName)<br />
<br />
; Return the Person 'object'<br />
Return $hPerson<br />
EndFunc ;==>Person<br />
<br />
; Getter for the age property<br />
Func Person_GetAge(ByRef $hPerson)<br />
Return _Person_IsObject($hPerson) ? $hPerson[$PERSON_AGE] : Null<br />
EndFunc ;==>Person_GetAge<br />
<br />
; Setter for the age property<br />
Func Person_SetAge(ByRef $hPerson, $iAge)<br />
; If not a valid 'object' or integer then return<br />
If Not _Person_IsObject($hPerson) Or Not IsInt($iAge) Then Return<br />
<br />
; Set the age<br />
$hPerson[$PERSON_AGE] = $iAge<br />
EndFunc ;==>Person_SetAge<br />
<br />
; Getter for the name property<br />
Func Person_GetName(ByRef $hPerson)<br />
Return _Person_IsObject($hPerson) ? $hPerson[$PERSON_NAME] : Null<br />
EndFunc ;==>Person_GetName<br />
<br />
; Setter for the name property<br />
Func Person_SetName(ByRef $hPerson, $sName)<br />
; If not a valid 'object' then return<br />
If Not _Person_IsObject($hPerson) Then Return<br />
<br />
; Set the name<br />
$hPerson[$PERSON_NAME] = $sName<br />
EndFunc ;==>Person_SetName<br />
<br />
; ToString() for the 'object'<br />
Func Person_ToString(ByRef $hPerson)<br />
Return _Person_IsObject($hPerson) ? StringFormat('Name: %s, Age: %i', $hPerson[$PERSON_NAME], $hPerson[$PERSON_AGE]) : Null<br />
EndFunc ;==>Person_ToString<br />
<br />
; Check if it's a valid 'object' and not some random array. "NTERNAL ONLY!<br />
Func _Person_IsObject(ByRef $hPerson)<br />
Return UBound($hPerson) = $PERSON_MAX And $hPerson[$PERSON_ID] == $PERSON_GUID<br />
EndFunc ;==>_Person_IsObject<br />
<br />
; ---- End of Person Class<br />
<br />
Example()<br />
<br />
Func Example()<br />
; Store the Person 'object', which is just a glorified array<br />
Local $hP1 = Person('John', 30)<br />
<br />
; Display the 'object'<br />
MsgBox($MB_SYSTEMMODAL, 'Person 1', Person_ToString($hP1))<br />
<br />
; Create a new person<br />
<br />
; Store the Person 'object', which is just a glorified array<br />
Local $hP2 = Person('James', 36)<br />
<br />
; Display the 'object'<br />
MsgBox($MB_SYSTEMMODAL, 'Person 2', Person_ToString($hP2))<br />
<br />
; Set the age for Person 2<br />
Person_SetAge($hP2, 45)<br />
<br />
; Display the 'object'<br />
MsgBox($MB_SYSTEMMODAL, 'Person 2 - Revised', Person_ToString($hP2))<br />
EndFunc ;==>Example<br />
</syntaxhighlight><br />
Please see the current beta for more information on map functions.<br />
<syntaxhighlight lang='autoit'><br />
</syntaxhighlight></div>Skysnakehttps://www.autoitscript.com/w/index.php?title=Associative_Arrays&diff=13733Associative Arrays2017-11-30T10:45:26Z<p>Skysnake: </p>
<hr />
<div>In computer science, an associative array, map, symbol table, or dictionary is an abstract data type composed of a collection of (key, value) pairs, such that each possible key appears at most once in the collection.<br />
An associative array differs from a “normal” array in one major way: rather than being indexed numerically (i.e. 0, 1, 2, 3, …), it is indexed by a key, or a language-like word. <br />
A '''Scripting.Dictionary''' is a standard '''''object''''' provided by the '''Microsoft Scripting Runtime''' (scrrun.dll) dependency and is commonly used in VBScript, a reference to which needs to be added in order to create an object in your AutoIt project.<br />
<br /><br />
<br /><br />
This discussion by '''Nutster''' explains the [https://www.autoitscript.com/forum/topic/59174-associative-array-functions/#comment-445963 original implementation] of Associative Arrays in AutoIt. <br />
An associative array is an array where the keys (index numbers) are string instead of integer, as they are in AutoIt. Linux / Unix awk and perl use associative arrays by default. The following functions can be used to manage a version of associative arrays in single AutoIt variables. A hash table is used to store the values because it is faster to insert than other options I can think of and pretty much as fast as them to retrieve the data. The memory requirements are a little higher than other methods, but I think it is a reasonable trade-off. It uses a simple hash function that can probably be easily improved upon and while it can resize the hash table, the resize is slow so try to make your initial size large enough for all your elements. Please see the Include file and an exerciser that demonstrates how to use the associative array functions. Read the comments at the top of each function for more details on their use.<br />
<br /><br />
<br /><br />
<big>Note:</big><br />
<br /><br />
AutoIt allows for at least two different implementations of Associative Arrays. The first method relies on a ''native'' AutoIt internal process handling named array elements, with no reference to the Scripting Dictionary. The second method relies on the Scripting Dictionary to create and manage associative arrays. <br /><br />
<br />
<br /><br />
<br />
A few notes on Associative Arrays:<br /><br />
* Think of an associative array as an array with named elements<br />
* Comparisons can be exact (binary) or case insensitive (alpha)<br />
<br /><br /><br />
At the time of writing this - 28 November 2017 - a new '''map data type''' is under development for AutoIt. It is availabe in the current [https://www.autoitscript.com/forum/topic/163657-maps-beta/?do=findComment&comment=1296278 beta release].<br />
<br /><br />
<br /><br />
Please also see this entry in the Snippets section of this Wiki [https://www.autoitscript.com/wiki/Snippets_(_AutoIt_Array_)#AssocArray _AssocArray] <br />
<br /><br />
<br /><br />
<br />
A dictionary object example by [https://www.autoitscript.com/forum/profile/2709-mhz/ MHz]<br />
<syntaxhighlight lang='autoit'><br />
; Author Mhz<br />
; Forum https://www.autoitscript.com/forum/topic/182334-scripting-dictionary-modified/<br />
Global $vKey, $sItem, $sMsg, $oDictionary <br />
<br />
; Create dictionary object<br />
$oDictionary = ObjCreate("Scripting.Dictionary")<br />
<br />
If @error Then<br />
MsgBox(0, '', 'Error creating the dictionary object')<br />
Else<br />
; Add keys with items<br />
$oDictionary.Add ("One", "Same" )<br />
$oDictionary.Add ("Two", "Car" )<br />
$oDictionary.Add ("Three", "House" )<br />
$oDictionary.Add ("Four", "Boat" )<br />
<br />
If $oDictionary.Exists('One') Then<br />
; Display item<br />
MsgBox(0x0, 'Item One', $oDictionary.Item('One'), 2)<br />
; Set an item<br />
$oDictionary.Item('One') = 'Changed'<br />
; Display item<br />
MsgBox(0x20, 'Did Item One Change?', $oDictionary.Item('One'), 3)<br />
; Remove key<br />
$oDictionary.Remove('One')<br />
; <br />
$oDictionary.Key ('Two') = 'Bike'<br />
EndIf<br />
<br />
Sleep(1000)<br />
<br />
; Store items into a variable<br />
For $vKey In $oDictionary<br />
$sItem &= $oDictionary.Item($vKey) & @CRLF<br />
Next<br />
<br />
; Display items<br />
MsgBox(0x0, 'Items Count: ' & $oDictionary.Count, $sItem, 3)<br />
<br />
; Add items into an array<br />
$aItems = $oDictionary.Items<br />
<br />
; Display items in the array<br />
For $i = 0 To $oDictionary.Count -1<br />
MsgBox(0x0, 'Items [ ' & $i & ' ]', $aItems[$i], 2)<br />
Next<br />
<br />
Sleep(1000)<br />
<br />
; Add keys into an array<br />
$aKeys = $oDictionary.Keys<br />
<br />
; Display keys in the array<br />
For $i = 0 To $oDictionary.Count -1<br />
MsgBox(0x0, 'Keys [ ' & $i & ' ]', $aKeys[$i], 2)<br />
Next<br />
EndIf<br />
</syntaxhighlight><br />
<br /><br />
<br /><br />
The original AutoIt Scripting Dictionary implementation appears to have been by Gary Frost as far back as 2007. It has since been modified to the following:<br />
<br /><br />
<syntaxhighlight lang='autoit'><br />
#cs<br />
Scripting Dictionary UDF<br />
<br />
Made by GaryFrost <https://www.autoitscript.com/forum/topic/47048-scripting-dictionary/><br />
Modified by Jefrey <jefrey[at]jefrey.ml><br />
<br />
Forum https://www.autoitscript.com/forum/topic/182334-scripting-dictionary-modified/<br />
<br />
#ce<br />
<br />
Func _InitDictionary()<br />
Return ObjCreate("Scripting.Dictionary")<br />
EndFunc ;==>_InitDictionary<br />
<br />
; Adds a key and item pair to a Dictionary object.<br />
Func _AddItem($oDictionary, $v_key, $v_item)<br />
$oDictionary.ADD($v_key, $v_item)<br />
If @error Then Return SetError(1, 1, -1)<br />
EndFunc ;==>_AddItem<br />
<br />
; Returns true if a specified key exists in the Dictionary object, false if it does not.<br />
Func _ItemExists($oDictionary, $v_key)<br />
Return $oDictionary.Exists($v_key)<br />
EndFunc ;==>_ItemExists<br />
<br />
; Returns an item for a specified key in a Dictionary object<br />
Func _Item($oDictionary, $v_key)<br />
Return $oDictionary.Item($v_key)<br />
EndFunc ;==>_Item<br />
<br />
; Sets an item for a specified key in a Dictionary object<br />
Func _ChangeItem($oDictionary, $v_key, $v_item)<br />
$oDictionary.Item($v_key) = $v_item<br />
EndFunc ;==>_ChangeItem<br />
<br />
; Sets a key in a Dictionary object.<br />
Func _ChangeKey($oDictionary, $v_key, $v_newKey)<br />
$oDictionary.Key($v_key) = $v_newKey<br />
EndFunc ;==>_ChangeKey<br />
<br />
; Removes a key, item pair from a Dictionary object.<br />
Func _ItemRemove($oDictionary, $v_key)<br />
$oDictionary.Remove($v_key)<br />
If @error Then Return SetError(1, 1, -1)<br />
EndFunc ;==>_ItemRemove<br />
<br />
; Returns the number of items in a collection or Dictionary object.<br />
Func _ItemCount($oDictionary)<br />
Return $oDictionary.Count<br />
EndFunc ;==>_ItemCount<br />
<br />
; Returns an array containing all the items in a Dictionary object<br />
Func _GetItems($oDictionary)<br />
Return $oDictionary.Items<br />
EndFunc ;==>_GetItems<br />
<br />
Func _Clear($oDictionary)<br />
Return $oDictionary.RemoveAll<br />
EndFunc<br />
<br />
</syntaxhighlight><br />
<br /><br />
<br /><br />
Below are several examples that illustrate the usage of the Scripting Dictionary UDF in AutoIt.<br />
<br /><br />
Example 1:<br />
<syntaxhighlight lang='autoit'><br />
; Author Jefrey<br />
; Forum https://www.autoitscript.com/forum/profile/75137-jefrey/<br />
#include 'scriptingdic.au3'<br />
#include <Array.au3> ; Needed only for _ArrayDisplay, and not required by the lib<br />
<br />
; Init the object<br />
$oObj = _InitDictionary()<br />
<br />
; Adding a single value<br />
_AddItem($oObj, 0, "Test")<br />
; And showing it<br />
msgbox(0, '', _Item($oObj, 0))<br />
<br />
; Adding an array<br />
Dim $aArr[] = [0, -80, -49, -44, 80, 100, 8, 7, 6, 5, 4, 3, 2, 1]<br />
_AddItem($oObj, 1, $aArr)<br />
; And showing it<br />
_ArrayDisplay(_Item($oObj, 1))<br />
<br />
; We can also use this approach:<br />
$oObj3 = _InitDictionary()<br />
$oObj.Add("test", "foo")<br />
MsgBox(0, '', $oObj.Item("test"))<br />
</syntaxhighlight><br />
Example 2 is a reply to a common question asked on the Forum, How to find duplicate lines/values... <br />
<syntaxhighlight lang='autoit'><br />
; Author Malkey <br />
; https://www.autoitscript.com/forum/profile/31256-malkey/<br />
; Forum https://www.autoitscript.com/forum/topic/116156-best-way-to-compare-strings-for-duplicates/?do=findComment&comment=810752<br />
Local $sStr, $begin, $dif, $sMatches<br />
<br />
; Create random test data<br />
For $i = 1 To 1000<br />
$sStr &= Chr(Random(Asc("a"), Asc("z"), 1)) & Chr(Random(Asc("a"), Asc("z"), 1)) & _<br />
Chr(Random(Asc("a"), Asc("z"), 1)) & Chr(Random(Asc("a"), Asc("z"), 1)) & @CRLF ;<br />
Next<br />
;ConsoleWrite($sStr & @CRLF)<br />
<br />
$begin = TimerInit()<br />
<br />
Local $oDict = ObjCreate("Scripting.Dictionary") ; to create a dictionary object<br />
Local $aArray = StringSplit(StringStripWS($sStr, 2), @CRLF, 3)<br />
For $i = 0 To UBound($aArray) - 1<br />
If $oDict.Exists($aArray[$i]) Then<br />
$sMatches &= $i & " " & $aArray[$i] & @CRLF ; Record duplicates<br />
Else<br />
$oDict.add($aArray[$i], '') ; to store a string (you may set $value = '' if you have no use of it)<br />
EndIf<br />
Next<br />
$dif = Round(TimerDiff($begin) / 1000, 3) & " secs"<br />
<br />
;Display results<br />
If $sMatches <> "" Then<br />
MsgBox(0, "Results", StringTrimRight($sMatches, 2) & @CRLF & "Time taken = " & $dif)<br />
Else<br />
MsgBox(0, "Results", "No duplicates found" & @CRLF & "Time taken = " & $dif)<br />
EndIf<br />
</syntaxhighlight><br />
<br /><br />
<br /><br /><br />
__________________________________________________________________________<br />
<br /><br />
While the examples above use the Scripting Dictionary method, the example below by guinness does not use the Scripting Dictionary. Also see [https://www.autoitscript.com/forum/topic/59174-associative-array-functions/ this discussion] by Nutster, with Associative Array management tools. <br />
<br />
The next example does not use the scripting dictionary UDF, but makes use of Global Enumerators. This allows access to data through named elements.<br />
<syntaxhighlight lang='autoit'><br />
; Author guinness<br />
; Forum https://www.autoitscript.com/forum/topic/173803-oop-like-approach-in-autoit/<br />
#include <MsgBoxConstants.au3><br />
<br />
; ---- Start of Person Class<br />
<br />
; Stored in the 'object' to verify it's our 'object' and not some random array<br />
Global Const $PERSON_GUID = '4197B285-6AB1-489B-8585-08C852E33F3D'<br />
<br />
; Friendly names for 0, 1, 2 and 3<br />
Global Enum $PERSON_AGE, $PERSON_NAME, $PERSON_ID, $PERSON_MAX<br />
<br />
; Constructor<br />
Func Person($sName, $iAge)<br />
Local $hPerson[$PERSON_MAX]<br />
<br />
; Set the GUID, so as the verification will work<br />
$hPerson[$PERSON_ID] = $PERSON_GUID<br />
<br />
Person_SetAge($hPerson, $iAge)<br />
Person_SetName($hPerson, $sName)<br />
<br />
; Return the Person 'object'<br />
Return $hPerson<br />
EndFunc ;==>Person<br />
<br />
; Getter for the age property<br />
Func Person_GetAge(ByRef $hPerson)<br />
Return _Person_IsObject($hPerson) ? $hPerson[$PERSON_AGE] : Null<br />
EndFunc ;==>Person_GetAge<br />
<br />
; Setter for the age property<br />
Func Person_SetAge(ByRef $hPerson, $iAge)<br />
; If not a valid 'object' or integer then return<br />
If Not _Person_IsObject($hPerson) Or Not IsInt($iAge) Then Return<br />
<br />
; Set the age<br />
$hPerson[$PERSON_AGE] = $iAge<br />
EndFunc ;==>Person_SetAge<br />
<br />
; Getter for the name property<br />
Func Person_GetName(ByRef $hPerson)<br />
Return _Person_IsObject($hPerson) ? $hPerson[$PERSON_NAME] : Null<br />
EndFunc ;==>Person_GetName<br />
<br />
; Setter for the name property<br />
Func Person_SetName(ByRef $hPerson, $sName)<br />
; If not a valid 'object' then return<br />
If Not _Person_IsObject($hPerson) Then Return<br />
<br />
; Set the name<br />
$hPerson[$PERSON_NAME] = $sName<br />
EndFunc ;==>Person_SetName<br />
<br />
; ToString() for the 'object'<br />
Func Person_ToString(ByRef $hPerson)<br />
Return _Person_IsObject($hPerson) ? StringFormat('Name: %s, Age: %i', $hPerson[$PERSON_NAME], $hPerson[$PERSON_AGE]) : Null<br />
EndFunc ;==>Person_ToString<br />
<br />
; Check if it's a valid 'object' and not some random array. "NTERNAL ONLY!<br />
Func _Person_IsObject(ByRef $hPerson)<br />
Return UBound($hPerson) = $PERSON_MAX And $hPerson[$PERSON_ID] == $PERSON_GUID<br />
EndFunc ;==>_Person_IsObject<br />
<br />
; ---- End of Person Class<br />
<br />
Example()<br />
<br />
Func Example()<br />
; Store the Person 'object', which is just a glorified array<br />
Local $hP1 = Person('John', 30)<br />
<br />
; Display the 'object'<br />
MsgBox($MB_SYSTEMMODAL, 'Person 1', Person_ToString($hP1))<br />
<br />
; Create a new person<br />
<br />
; Store the Person 'object', which is just a glorified array<br />
Local $hP2 = Person('James', 36)<br />
<br />
; Display the 'object'<br />
MsgBox($MB_SYSTEMMODAL, 'Person 2', Person_ToString($hP2))<br />
<br />
; Set the age for Person 2<br />
Person_SetAge($hP2, 45)<br />
<br />
; Display the 'object'<br />
MsgBox($MB_SYSTEMMODAL, 'Person 2 - Revised', Person_ToString($hP2))<br />
EndFunc ;==>Example<br />
</syntaxhighlight><br />
Please see the current beta for more information on map functions.<br />
<syntaxhighlight lang='autoit'><br />
</syntaxhighlight></div>Skysnakehttps://www.autoitscript.com/w/index.php?title=Associative_Arrays&diff=13732Associative Arrays2017-11-30T10:44:50Z<p>Skysnake: </p>
<hr />
<div>In computer science, an associative array, map, symbol table, or dictionary is an abstract data type composed of a collection of (key, value) pairs, such that each possible key appears at most once in the collection.<br />
An associative array differs from a “normal” array in one major way: rather than being indexed numerically (i.e. 0, 1, 2, 3, …), it is indexed by a key, or a language-like word. <br />
A '''Scripting.Dictionary''' is a standard '''''object''''' provided by the '''Microsoft Scripting Runtime''' (scrrun.dll) dependency and is commonly used in VBScript, a reference to which needs to be added in order to create an object in your AutoIt project.<br />
<br /><br />
<br /><br />
This discussion by '''Nutster''' explains the [https://www.autoitscript.com/forum/topic/59174-associative-array-functions/#comment-445963 original implementation] of Associative Arrays in AutoIt. <br />
An associative array is an array where the keys (index numbers) are string instead of integer, as they are in AutoIt. Linux / Unix awk and perl use associative arrays by default. The following functions can be used to manage a version of associative arrays in single AutoIt variables. A hash table is used to store the values because it is faster to insert than other options I can think of and pretty much as fast as them to retrieve the data. The memory requirements are a little higher than other methods, but I think it is a reasonable trade-off. It uses a simple hash function that can probably be easily improved upon and while it can resize the hash table, the resize is slow so try to make your initial size large enough for all your elements. Please see the Include file and an exerciser that demonstrates how to use the associative array functions. Read the comments at the top of each function for more details on their use.<br />
<br /><br />
<br /><br />
<big>Note:</big><br />
<br /><br />
AutoIt allows for at least two different implementations of Associative Arrays. The first method relies on a native AutoIt ''internal'' process handling named array elements, with no reference to the Scripting Dictionary. The second method relies on the Scripting Dictionary to create and manage associative arrays. <br /><br />
<br />
<br /><br />
<br />
A few notes on Associative Arrays:<br /><br />
* Think of an associative array as an array with named elements<br />
* Comparisons can be exact (binary) or case insensitive (alpha)<br />
<br /><br /><br />
At the time of writing this - 28 November 2017 - a new '''map data type''' is under development for AutoIt. It is availabe in the current [https://www.autoitscript.com/forum/topic/163657-maps-beta/?do=findComment&comment=1296278 beta release].<br />
<br /><br />
<br /><br />
Please also see this entry in the Snippets section of this Wiki [https://www.autoitscript.com/wiki/Snippets_(_AutoIt_Array_)#AssocArray _AssocArray] <br />
<br /><br />
<br /><br />
<br />
A dictionary object example by [https://www.autoitscript.com/forum/profile/2709-mhz/ MHz]<br />
<syntaxhighlight lang='autoit'><br />
; Author Mhz<br />
; Forum https://www.autoitscript.com/forum/topic/182334-scripting-dictionary-modified/<br />
Global $vKey, $sItem, $sMsg, $oDictionary <br />
<br />
; Create dictionary object<br />
$oDictionary = ObjCreate("Scripting.Dictionary")<br />
<br />
If @error Then<br />
MsgBox(0, '', 'Error creating the dictionary object')<br />
Else<br />
; Add keys with items<br />
$oDictionary.Add ("One", "Same" )<br />
$oDictionary.Add ("Two", "Car" )<br />
$oDictionary.Add ("Three", "House" )<br />
$oDictionary.Add ("Four", "Boat" )<br />
<br />
If $oDictionary.Exists('One') Then<br />
; Display item<br />
MsgBox(0x0, 'Item One', $oDictionary.Item('One'), 2)<br />
; Set an item<br />
$oDictionary.Item('One') = 'Changed'<br />
; Display item<br />
MsgBox(0x20, 'Did Item One Change?', $oDictionary.Item('One'), 3)<br />
; Remove key<br />
$oDictionary.Remove('One')<br />
; <br />
$oDictionary.Key ('Two') = 'Bike'<br />
EndIf<br />
<br />
Sleep(1000)<br />
<br />
; Store items into a variable<br />
For $vKey In $oDictionary<br />
$sItem &= $oDictionary.Item($vKey) & @CRLF<br />
Next<br />
<br />
; Display items<br />
MsgBox(0x0, 'Items Count: ' & $oDictionary.Count, $sItem, 3)<br />
<br />
; Add items into an array<br />
$aItems = $oDictionary.Items<br />
<br />
; Display items in the array<br />
For $i = 0 To $oDictionary.Count -1<br />
MsgBox(0x0, 'Items [ ' & $i & ' ]', $aItems[$i], 2)<br />
Next<br />
<br />
Sleep(1000)<br />
<br />
; Add keys into an array<br />
$aKeys = $oDictionary.Keys<br />
<br />
; Display keys in the array<br />
For $i = 0 To $oDictionary.Count -1<br />
MsgBox(0x0, 'Keys [ ' & $i & ' ]', $aKeys[$i], 2)<br />
Next<br />
EndIf<br />
</syntaxhighlight><br />
<br /><br />
<br /><br />
The original AutoIt Scripting Dictionary implementation appears to have been by Gary Frost as far back as 2007. It has since been modified to the following:<br />
<br /><br />
<syntaxhighlight lang='autoit'><br />
#cs<br />
Scripting Dictionary UDF<br />
<br />
Made by GaryFrost <https://www.autoitscript.com/forum/topic/47048-scripting-dictionary/><br />
Modified by Jefrey <jefrey[at]jefrey.ml><br />
<br />
Forum https://www.autoitscript.com/forum/topic/182334-scripting-dictionary-modified/<br />
<br />
#ce<br />
<br />
Func _InitDictionary()<br />
Return ObjCreate("Scripting.Dictionary")<br />
EndFunc ;==>_InitDictionary<br />
<br />
; Adds a key and item pair to a Dictionary object.<br />
Func _AddItem($oDictionary, $v_key, $v_item)<br />
$oDictionary.ADD($v_key, $v_item)<br />
If @error Then Return SetError(1, 1, -1)<br />
EndFunc ;==>_AddItem<br />
<br />
; Returns true if a specified key exists in the Dictionary object, false if it does not.<br />
Func _ItemExists($oDictionary, $v_key)<br />
Return $oDictionary.Exists($v_key)<br />
EndFunc ;==>_ItemExists<br />
<br />
; Returns an item for a specified key in a Dictionary object<br />
Func _Item($oDictionary, $v_key)<br />
Return $oDictionary.Item($v_key)<br />
EndFunc ;==>_Item<br />
<br />
; Sets an item for a specified key in a Dictionary object<br />
Func _ChangeItem($oDictionary, $v_key, $v_item)<br />
$oDictionary.Item($v_key) = $v_item<br />
EndFunc ;==>_ChangeItem<br />
<br />
; Sets a key in a Dictionary object.<br />
Func _ChangeKey($oDictionary, $v_key, $v_newKey)<br />
$oDictionary.Key($v_key) = $v_newKey<br />
EndFunc ;==>_ChangeKey<br />
<br />
; Removes a key, item pair from a Dictionary object.<br />
Func _ItemRemove($oDictionary, $v_key)<br />
$oDictionary.Remove($v_key)<br />
If @error Then Return SetError(1, 1, -1)<br />
EndFunc ;==>_ItemRemove<br />
<br />
; Returns the number of items in a collection or Dictionary object.<br />
Func _ItemCount($oDictionary)<br />
Return $oDictionary.Count<br />
EndFunc ;==>_ItemCount<br />
<br />
; Returns an array containing all the items in a Dictionary object<br />
Func _GetItems($oDictionary)<br />
Return $oDictionary.Items<br />
EndFunc ;==>_GetItems<br />
<br />
Func _Clear($oDictionary)<br />
Return $oDictionary.RemoveAll<br />
EndFunc<br />
<br />
</syntaxhighlight><br />
<br /><br />
<br /><br />
Below are several examples that illustrate the usage of the Scripting Dictionary UDF in AutoIt.<br />
<br /><br />
Example 1:<br />
<syntaxhighlight lang='autoit'><br />
; Author Jefrey<br />
; Forum https://www.autoitscript.com/forum/profile/75137-jefrey/<br />
#include 'scriptingdic.au3'<br />
#include <Array.au3> ; Needed only for _ArrayDisplay, and not required by the lib<br />
<br />
; Init the object<br />
$oObj = _InitDictionary()<br />
<br />
; Adding a single value<br />
_AddItem($oObj, 0, "Test")<br />
; And showing it<br />
msgbox(0, '', _Item($oObj, 0))<br />
<br />
; Adding an array<br />
Dim $aArr[] = [0, -80, -49, -44, 80, 100, 8, 7, 6, 5, 4, 3, 2, 1]<br />
_AddItem($oObj, 1, $aArr)<br />
; And showing it<br />
_ArrayDisplay(_Item($oObj, 1))<br />
<br />
; We can also use this approach:<br />
$oObj3 = _InitDictionary()<br />
$oObj.Add("test", "foo")<br />
MsgBox(0, '', $oObj.Item("test"))<br />
</syntaxhighlight><br />
Example 2 is a reply to a common question asked on the Forum, How to find duplicate lines/values... <br />
<syntaxhighlight lang='autoit'><br />
; Author Malkey <br />
; https://www.autoitscript.com/forum/profile/31256-malkey/<br />
; Forum https://www.autoitscript.com/forum/topic/116156-best-way-to-compare-strings-for-duplicates/?do=findComment&comment=810752<br />
Local $sStr, $begin, $dif, $sMatches<br />
<br />
; Create random test data<br />
For $i = 1 To 1000<br />
$sStr &= Chr(Random(Asc("a"), Asc("z"), 1)) & Chr(Random(Asc("a"), Asc("z"), 1)) & _<br />
Chr(Random(Asc("a"), Asc("z"), 1)) & Chr(Random(Asc("a"), Asc("z"), 1)) & @CRLF ;<br />
Next<br />
;ConsoleWrite($sStr & @CRLF)<br />
<br />
$begin = TimerInit()<br />
<br />
Local $oDict = ObjCreate("Scripting.Dictionary") ; to create a dictionary object<br />
Local $aArray = StringSplit(StringStripWS($sStr, 2), @CRLF, 3)<br />
For $i = 0 To UBound($aArray) - 1<br />
If $oDict.Exists($aArray[$i]) Then<br />
$sMatches &= $i & " " & $aArray[$i] & @CRLF ; Record duplicates<br />
Else<br />
$oDict.add($aArray[$i], '') ; to store a string (you may set $value = '' if you have no use of it)<br />
EndIf<br />
Next<br />
$dif = Round(TimerDiff($begin) / 1000, 3) & " secs"<br />
<br />
;Display results<br />
If $sMatches <> "" Then<br />
MsgBox(0, "Results", StringTrimRight($sMatches, 2) & @CRLF & "Time taken = " & $dif)<br />
Else<br />
MsgBox(0, "Results", "No duplicates found" & @CRLF & "Time taken = " & $dif)<br />
EndIf<br />
</syntaxhighlight><br />
<br /><br />
<br /><br /><br />
__________________________________________________________________________<br />
<br /><br />
While the examples above use the Scripting Dictionary method, the example below by guinness does not use the Scripting Dictionary. Also see [https://www.autoitscript.com/forum/topic/59174-associative-array-functions/ this discussion] by Nutster, with Associative Array management tools. <br />
<br />
The next example does not use the scripting dictionary UDF, but makes use of Global Enumerators. This allows access to data through named elements.<br />
<syntaxhighlight lang='autoit'><br />
; Author guinness<br />
; Forum https://www.autoitscript.com/forum/topic/173803-oop-like-approach-in-autoit/<br />
#include <MsgBoxConstants.au3><br />
<br />
; ---- Start of Person Class<br />
<br />
; Stored in the 'object' to verify it's our 'object' and not some random array<br />
Global Const $PERSON_GUID = '4197B285-6AB1-489B-8585-08C852E33F3D'<br />
<br />
; Friendly names for 0, 1, 2 and 3<br />
Global Enum $PERSON_AGE, $PERSON_NAME, $PERSON_ID, $PERSON_MAX<br />
<br />
; Constructor<br />
Func Person($sName, $iAge)<br />
Local $hPerson[$PERSON_MAX]<br />
<br />
; Set the GUID, so as the verification will work<br />
$hPerson[$PERSON_ID] = $PERSON_GUID<br />
<br />
Person_SetAge($hPerson, $iAge)<br />
Person_SetName($hPerson, $sName)<br />
<br />
; Return the Person 'object'<br />
Return $hPerson<br />
EndFunc ;==>Person<br />
<br />
; Getter for the age property<br />
Func Person_GetAge(ByRef $hPerson)<br />
Return _Person_IsObject($hPerson) ? $hPerson[$PERSON_AGE] : Null<br />
EndFunc ;==>Person_GetAge<br />
<br />
; Setter for the age property<br />
Func Person_SetAge(ByRef $hPerson, $iAge)<br />
; If not a valid 'object' or integer then return<br />
If Not _Person_IsObject($hPerson) Or Not IsInt($iAge) Then Return<br />
<br />
; Set the age<br />
$hPerson[$PERSON_AGE] = $iAge<br />
EndFunc ;==>Person_SetAge<br />
<br />
; Getter for the name property<br />
Func Person_GetName(ByRef $hPerson)<br />
Return _Person_IsObject($hPerson) ? $hPerson[$PERSON_NAME] : Null<br />
EndFunc ;==>Person_GetName<br />
<br />
; Setter for the name property<br />
Func Person_SetName(ByRef $hPerson, $sName)<br />
; If not a valid 'object' then return<br />
If Not _Person_IsObject($hPerson) Then Return<br />
<br />
; Set the name<br />
$hPerson[$PERSON_NAME] = $sName<br />
EndFunc ;==>Person_SetName<br />
<br />
; ToString() for the 'object'<br />
Func Person_ToString(ByRef $hPerson)<br />
Return _Person_IsObject($hPerson) ? StringFormat('Name: %s, Age: %i', $hPerson[$PERSON_NAME], $hPerson[$PERSON_AGE]) : Null<br />
EndFunc ;==>Person_ToString<br />
<br />
; Check if it's a valid 'object' and not some random array. "NTERNAL ONLY!<br />
Func _Person_IsObject(ByRef $hPerson)<br />
Return UBound($hPerson) = $PERSON_MAX And $hPerson[$PERSON_ID] == $PERSON_GUID<br />
EndFunc ;==>_Person_IsObject<br />
<br />
; ---- End of Person Class<br />
<br />
Example()<br />
<br />
Func Example()<br />
; Store the Person 'object', which is just a glorified array<br />
Local $hP1 = Person('John', 30)<br />
<br />
; Display the 'object'<br />
MsgBox($MB_SYSTEMMODAL, 'Person 1', Person_ToString($hP1))<br />
<br />
; Create a new person<br />
<br />
; Store the Person 'object', which is just a glorified array<br />
Local $hP2 = Person('James', 36)<br />
<br />
; Display the 'object'<br />
MsgBox($MB_SYSTEMMODAL, 'Person 2', Person_ToString($hP2))<br />
<br />
; Set the age for Person 2<br />
Person_SetAge($hP2, 45)<br />
<br />
; Display the 'object'<br />
MsgBox($MB_SYSTEMMODAL, 'Person 2 - Revised', Person_ToString($hP2))<br />
EndFunc ;==>Example<br />
</syntaxhighlight><br />
Please see the current beta for more information on map functions.<br />
<syntaxhighlight lang='autoit'><br />
</syntaxhighlight></div>Skysnakehttps://www.autoitscript.com/w/index.php?title=Associative_Arrays&diff=13731Associative Arrays2017-11-30T10:35:19Z<p>Skysnake: </p>
<hr />
<div>In computer science, an associative array, map, symbol table, or dictionary is an abstract data type composed of a collection of (key, value) pairs, such that each possible key appears at most once in the collection.<br />
An associative array differs from a “normal” array in one major way: rather than being indexed numerically (i.e. 0, 1, 2, 3, …), it is indexed by a key, or a language-like word. <br />
A '''Scripting.Dictionary''' is a standard '''''object''''' provided by the '''Microsoft Scripting Runtime''' (scrrun.dll) dependency and is commonly used in VBScript, a reference to which needs to be added in order to create an object in your AutoIt project.<br />
<br /><br />
<br /><br />
This discussion by '''Nutster''' explains the [https://www.autoitscript.com/forum/topic/59174-associative-array-functions/#comment-445963 original implementation] of Associative Arrays in AutoIt. <br />
An associative array is an array where the keys (index numbers) are string instead of integer, as they are in AutoIt. Linux / Unix awk and perl use associative arrays by default. The following functions can be used to manage a version of associative arrays in single AutoIt variables. A hash table is used to store the values because it is faster to insert than other options I can think of and pretty much as fast as them to retrieve the data. The memory requirements are a little higher than other methods, but I think it is a reasonable trade-off. It uses a simple hash function that can probably be easily improved upon and while it can resize the hash table, the resize is slow so try to make your initial size large enough for all your elements. Please see the Include file and an exerciser that demonstrates how to use the associative array functions. Read the comments at the top of each function for more details on their use.<br />
<br /><br />
<br /><br />
<big>Note:</big><br />
<br /><br />
AutoIt allows for at least two different implementations of Associative Arrays. The first method relies on AutoIt internally processing named array elements, with no reference to the Scripting Dictionary. The second method relies on the Scripting Dictionary to create and manage associative arrays. <br /><br />
<br />
<br /><br />
<br />
A few notes on Associative Arrays:<br /><br />
* Think of an associative array as an array with named elements<br />
* Comparisons can be exact (binary) or case insensitive (alpha)<br />
<br /><br /><br />
At the time of writing this - 28 November 2017 - a new '''map data type''' is under development for AutoIt. It is availabe in the current [https://www.autoitscript.com/forum/topic/163657-maps-beta/?do=findComment&comment=1296278 beta release].<br />
<br /><br />
<br /><br />
Please also see this entry in the Snippets section of this Wiki [https://www.autoitscript.com/wiki/Snippets_(_AutoIt_Array_)#AssocArray _AssocArray] <br />
<br /><br />
<br /><br />
<br />
A dictionary object example by [https://www.autoitscript.com/forum/profile/2709-mhz/ MHz]<br />
<syntaxhighlight lang='autoit'><br />
; Author Mhz<br />
; Forum https://www.autoitscript.com/forum/topic/182334-scripting-dictionary-modified/<br />
Global $vKey, $sItem, $sMsg, $oDictionary <br />
<br />
; Create dictionary object<br />
$oDictionary = ObjCreate("Scripting.Dictionary")<br />
<br />
If @error Then<br />
MsgBox(0, '', 'Error creating the dictionary object')<br />
Else<br />
; Add keys with items<br />
$oDictionary.Add ("One", "Same" )<br />
$oDictionary.Add ("Two", "Car" )<br />
$oDictionary.Add ("Three", "House" )<br />
$oDictionary.Add ("Four", "Boat" )<br />
<br />
If $oDictionary.Exists('One') Then<br />
; Display item<br />
MsgBox(0x0, 'Item One', $oDictionary.Item('One'), 2)<br />
; Set an item<br />
$oDictionary.Item('One') = 'Changed'<br />
; Display item<br />
MsgBox(0x20, 'Did Item One Change?', $oDictionary.Item('One'), 3)<br />
; Remove key<br />
$oDictionary.Remove('One')<br />
; <br />
$oDictionary.Key ('Two') = 'Bike'<br />
EndIf<br />
<br />
Sleep(1000)<br />
<br />
; Store items into a variable<br />
For $vKey In $oDictionary<br />
$sItem &= $oDictionary.Item($vKey) & @CRLF<br />
Next<br />
<br />
; Display items<br />
MsgBox(0x0, 'Items Count: ' & $oDictionary.Count, $sItem, 3)<br />
<br />
; Add items into an array<br />
$aItems = $oDictionary.Items<br />
<br />
; Display items in the array<br />
For $i = 0 To $oDictionary.Count -1<br />
MsgBox(0x0, 'Items [ ' & $i & ' ]', $aItems[$i], 2)<br />
Next<br />
<br />
Sleep(1000)<br />
<br />
; Add keys into an array<br />
$aKeys = $oDictionary.Keys<br />
<br />
; Display keys in the array<br />
For $i = 0 To $oDictionary.Count -1<br />
MsgBox(0x0, 'Keys [ ' & $i & ' ]', $aKeys[$i], 2)<br />
Next<br />
EndIf<br />
</syntaxhighlight><br />
<br /><br />
<br /><br />
The original AutoIt Scripting Dictionary implementation appears to have been by Gary Frost as far back as 2007. It has since been modified to the following:<br />
<br /><br />
<syntaxhighlight lang='autoit'><br />
#cs<br />
Scripting Dictionary UDF<br />
<br />
Made by GaryFrost <https://www.autoitscript.com/forum/topic/47048-scripting-dictionary/><br />
Modified by Jefrey <jefrey[at]jefrey.ml><br />
<br />
Forum https://www.autoitscript.com/forum/topic/182334-scripting-dictionary-modified/<br />
<br />
#ce<br />
<br />
Func _InitDictionary()<br />
Return ObjCreate("Scripting.Dictionary")<br />
EndFunc ;==>_InitDictionary<br />
<br />
; Adds a key and item pair to a Dictionary object.<br />
Func _AddItem($oDictionary, $v_key, $v_item)<br />
$oDictionary.ADD($v_key, $v_item)<br />
If @error Then Return SetError(1, 1, -1)<br />
EndFunc ;==>_AddItem<br />
<br />
; Returns true if a specified key exists in the Dictionary object, false if it does not.<br />
Func _ItemExists($oDictionary, $v_key)<br />
Return $oDictionary.Exists($v_key)<br />
EndFunc ;==>_ItemExists<br />
<br />
; Returns an item for a specified key in a Dictionary object<br />
Func _Item($oDictionary, $v_key)<br />
Return $oDictionary.Item($v_key)<br />
EndFunc ;==>_Item<br />
<br />
; Sets an item for a specified key in a Dictionary object<br />
Func _ChangeItem($oDictionary, $v_key, $v_item)<br />
$oDictionary.Item($v_key) = $v_item<br />
EndFunc ;==>_ChangeItem<br />
<br />
; Sets a key in a Dictionary object.<br />
Func _ChangeKey($oDictionary, $v_key, $v_newKey)<br />
$oDictionary.Key($v_key) = $v_newKey<br />
EndFunc ;==>_ChangeKey<br />
<br />
; Removes a key, item pair from a Dictionary object.<br />
Func _ItemRemove($oDictionary, $v_key)<br />
$oDictionary.Remove($v_key)<br />
If @error Then Return SetError(1, 1, -1)<br />
EndFunc ;==>_ItemRemove<br />
<br />
; Returns the number of items in a collection or Dictionary object.<br />
Func _ItemCount($oDictionary)<br />
Return $oDictionary.Count<br />
EndFunc ;==>_ItemCount<br />
<br />
; Returns an array containing all the items in a Dictionary object<br />
Func _GetItems($oDictionary)<br />
Return $oDictionary.Items<br />
EndFunc ;==>_GetItems<br />
<br />
Func _Clear($oDictionary)<br />
Return $oDictionary.RemoveAll<br />
EndFunc<br />
<br />
</syntaxhighlight><br />
<br /><br />
<br /><br />
Below are several examples that illustrate the usage of the Scripting Dictionary UDF in AutoIt.<br />
<br /><br />
Example 1:<br />
<syntaxhighlight lang='autoit'><br />
; Author Jefrey<br />
; Forum https://www.autoitscript.com/forum/profile/75137-jefrey/<br />
#include 'scriptingdic.au3'<br />
#include <Array.au3> ; Needed only for _ArrayDisplay, and not required by the lib<br />
<br />
; Init the object<br />
$oObj = _InitDictionary()<br />
<br />
; Adding a single value<br />
_AddItem($oObj, 0, "Test")<br />
; And showing it<br />
msgbox(0, '', _Item($oObj, 0))<br />
<br />
; Adding an array<br />
Dim $aArr[] = [0, -80, -49, -44, 80, 100, 8, 7, 6, 5, 4, 3, 2, 1]<br />
_AddItem($oObj, 1, $aArr)<br />
; And showing it<br />
_ArrayDisplay(_Item($oObj, 1))<br />
<br />
; We can also use this approach:<br />
$oObj3 = _InitDictionary()<br />
$oObj.Add("test", "foo")<br />
MsgBox(0, '', $oObj.Item("test"))<br />
</syntaxhighlight><br />
Example 2 is a reply to a common question asked on the Forum, How to find duplicate lines/values... <br />
<syntaxhighlight lang='autoit'><br />
; Author Malkey <br />
; https://www.autoitscript.com/forum/profile/31256-malkey/<br />
; Forum https://www.autoitscript.com/forum/topic/116156-best-way-to-compare-strings-for-duplicates/?do=findComment&comment=810752<br />
Local $sStr, $begin, $dif, $sMatches<br />
<br />
; Create random test data<br />
For $i = 1 To 1000<br />
$sStr &= Chr(Random(Asc("a"), Asc("z"), 1)) & Chr(Random(Asc("a"), Asc("z"), 1)) & _<br />
Chr(Random(Asc("a"), Asc("z"), 1)) & Chr(Random(Asc("a"), Asc("z"), 1)) & @CRLF ;<br />
Next<br />
;ConsoleWrite($sStr & @CRLF)<br />
<br />
$begin = TimerInit()<br />
<br />
Local $oDict = ObjCreate("Scripting.Dictionary") ; to create a dictionary object<br />
Local $aArray = StringSplit(StringStripWS($sStr, 2), @CRLF, 3)<br />
For $i = 0 To UBound($aArray) - 1<br />
If $oDict.Exists($aArray[$i]) Then<br />
$sMatches &= $i & " " & $aArray[$i] & @CRLF ; Record duplicates<br />
Else<br />
$oDict.add($aArray[$i], '') ; to store a string (you may set $value = '' if you have no use of it)<br />
EndIf<br />
Next<br />
$dif = Round(TimerDiff($begin) / 1000, 3) & " secs"<br />
<br />
;Display results<br />
If $sMatches <> "" Then<br />
MsgBox(0, "Results", StringTrimRight($sMatches, 2) & @CRLF & "Time taken = " & $dif)<br />
Else<br />
MsgBox(0, "Results", "No duplicates found" & @CRLF & "Time taken = " & $dif)<br />
EndIf<br />
</syntaxhighlight><br />
<br /><br />
<br /><br /><br />
__________________________________________________________________________<br />
<br /><br />
While the examples above use the Scripting Dictionary method, the example below by guinness does not use the Scripting Dictionary. Also see [https://www.autoitscript.com/forum/topic/59174-associative-array-functions/ this discussion] by Nutster, with Associative Array management tools. <br />
<br />
The next example does not use the scripting dictionary UDF, but makes use of Global Enumerators. This allows access to data through named elements.<br />
<syntaxhighlight lang='autoit'><br />
; Author guinness<br />
; Forum https://www.autoitscript.com/forum/topic/173803-oop-like-approach-in-autoit/<br />
#include <MsgBoxConstants.au3><br />
<br />
; ---- Start of Person Class<br />
<br />
; Stored in the 'object' to verify it's our 'object' and not some random array<br />
Global Const $PERSON_GUID = '4197B285-6AB1-489B-8585-08C852E33F3D'<br />
<br />
; Friendly names for 0, 1, 2 and 3<br />
Global Enum $PERSON_AGE, $PERSON_NAME, $PERSON_ID, $PERSON_MAX<br />
<br />
; Constructor<br />
Func Person($sName, $iAge)<br />
Local $hPerson[$PERSON_MAX]<br />
<br />
; Set the GUID, so as the verification will work<br />
$hPerson[$PERSON_ID] = $PERSON_GUID<br />
<br />
Person_SetAge($hPerson, $iAge)<br />
Person_SetName($hPerson, $sName)<br />
<br />
; Return the Person 'object'<br />
Return $hPerson<br />
EndFunc ;==>Person<br />
<br />
; Getter for the age property<br />
Func Person_GetAge(ByRef $hPerson)<br />
Return _Person_IsObject($hPerson) ? $hPerson[$PERSON_AGE] : Null<br />
EndFunc ;==>Person_GetAge<br />
<br />
; Setter for the age property<br />
Func Person_SetAge(ByRef $hPerson, $iAge)<br />
; If not a valid 'object' or integer then return<br />
If Not _Person_IsObject($hPerson) Or Not IsInt($iAge) Then Return<br />
<br />
; Set the age<br />
$hPerson[$PERSON_AGE] = $iAge<br />
EndFunc ;==>Person_SetAge<br />
<br />
; Getter for the name property<br />
Func Person_GetName(ByRef $hPerson)<br />
Return _Person_IsObject($hPerson) ? $hPerson[$PERSON_NAME] : Null<br />
EndFunc ;==>Person_GetName<br />
<br />
; Setter for the name property<br />
Func Person_SetName(ByRef $hPerson, $sName)<br />
; If not a valid 'object' then return<br />
If Not _Person_IsObject($hPerson) Then Return<br />
<br />
; Set the name<br />
$hPerson[$PERSON_NAME] = $sName<br />
EndFunc ;==>Person_SetName<br />
<br />
; ToString() for the 'object'<br />
Func Person_ToString(ByRef $hPerson)<br />
Return _Person_IsObject($hPerson) ? StringFormat('Name: %s, Age: %i', $hPerson[$PERSON_NAME], $hPerson[$PERSON_AGE]) : Null<br />
EndFunc ;==>Person_ToString<br />
<br />
; Check if it's a valid 'object' and not some random array. "NTERNAL ONLY!<br />
Func _Person_IsObject(ByRef $hPerson)<br />
Return UBound($hPerson) = $PERSON_MAX And $hPerson[$PERSON_ID] == $PERSON_GUID<br />
EndFunc ;==>_Person_IsObject<br />
<br />
; ---- End of Person Class<br />
<br />
Example()<br />
<br />
Func Example()<br />
; Store the Person 'object', which is just a glorified array<br />
Local $hP1 = Person('John', 30)<br />
<br />
; Display the 'object'<br />
MsgBox($MB_SYSTEMMODAL, 'Person 1', Person_ToString($hP1))<br />
<br />
; Create a new person<br />
<br />
; Store the Person 'object', which is just a glorified array<br />
Local $hP2 = Person('James', 36)<br />
<br />
; Display the 'object'<br />
MsgBox($MB_SYSTEMMODAL, 'Person 2', Person_ToString($hP2))<br />
<br />
; Set the age for Person 2<br />
Person_SetAge($hP2, 45)<br />
<br />
; Display the 'object'<br />
MsgBox($MB_SYSTEMMODAL, 'Person 2 - Revised', Person_ToString($hP2))<br />
EndFunc ;==>Example<br />
</syntaxhighlight><br />
Please see the current beta for more information on map functions.<br />
<syntaxhighlight lang='autoit'><br />
</syntaxhighlight></div>Skysnakehttps://www.autoitscript.com/w/index.php?title=Associative_Arrays&diff=13730Associative Arrays2017-11-30T10:34:20Z<p>Skysnake: </p>
<hr />
<div>In computer science, an associative array, map, symbol table, or dictionary is an abstract data type composed of a collection of (key, value) pairs, such that each possible key appears at most once in the collection.<br />
An associative array differs from a “normal” array in one major way: rather than being indexed numerically (i.e. 0, 1, 2, 3, …), it is indexed by a key, or a language-like word. <br />
A '''Scripting.Dictionary''' is a standard object provided by the '''Microsoft Scripting Runtime''' (scrrun.dll) dependency and is commonly used in VBScript, a reference to which needs to be added in order to create an object in your AutoIt project.<br />
<br /><br />
<br /><br />
This discussion by '''Nutster''' explains the [https://www.autoitscript.com/forum/topic/59174-associative-array-functions/#comment-445963 original implementation] of Associative Arrays in AutoIt. <br />
An associative array is an array where the keys (index numbers) are string instead of integer, as they are in AutoIt. Linux / Unix awk and perl use associative arrays by default. The following functions can be used to manage a version of associative arrays in single AutoIt variables. A hash table is used to store the values because it is faster to insert than other options I can think of and pretty much as fast as them to retrieve the data. The memory requirements are a little higher than other methods, but I think it is a reasonable trade-off. It uses a simple hash function that can probably be easily improved upon and while it can resize the hash table, the resize is slow so try to make your initial size large enough for all your elements. Please see the Include file and an exerciser that demonstrates how to use the associative array functions. Read the comments at the top of each function for more details on their use.<br />
<br /><br />
<br /><br />
<big>Note:</big><br />
<br /><br />
AutoIt allows for at least two different implementations of Associative Arrays. The first method relies on AutoIt internally processing named array elements, with no reference to the Scripting Dictionary. The second method relies on the Scripting Dictionary to create and manage associative arrays. <br /><br />
<br />
<br /><br />
<br />
A few notes on Associative Arrays:<br /><br />
* Think of an associative array as an array with named elements<br />
* Comparisons can be exact (binary) or case insensitive (alpha)<br />
<br /><br /><br />
At the time of writing this - 28 November 2017 - a new '''map data type''' is under development for AutoIt. It is availabe in the current [https://www.autoitscript.com/forum/topic/163657-maps-beta/?do=findComment&comment=1296278 beta release].<br />
<br /><br />
<br /><br />
Please also see this entry in the Snippets section of this Wiki [https://www.autoitscript.com/wiki/Snippets_(_AutoIt_Array_)#AssocArray _AssocArray] <br />
<br /><br />
<br /><br />
<br />
A dictionary object example by [https://www.autoitscript.com/forum/profile/2709-mhz/ MHz]<br />
<syntaxhighlight lang='autoit'><br />
; Author Mhz<br />
; Forum https://www.autoitscript.com/forum/topic/182334-scripting-dictionary-modified/<br />
Global $vKey, $sItem, $sMsg, $oDictionary <br />
<br />
; Create dictionary object<br />
$oDictionary = ObjCreate("Scripting.Dictionary")<br />
<br />
If @error Then<br />
MsgBox(0, '', 'Error creating the dictionary object')<br />
Else<br />
; Add keys with items<br />
$oDictionary.Add ("One", "Same" )<br />
$oDictionary.Add ("Two", "Car" )<br />
$oDictionary.Add ("Three", "House" )<br />
$oDictionary.Add ("Four", "Boat" )<br />
<br />
If $oDictionary.Exists('One') Then<br />
; Display item<br />
MsgBox(0x0, 'Item One', $oDictionary.Item('One'), 2)<br />
; Set an item<br />
$oDictionary.Item('One') = 'Changed'<br />
; Display item<br />
MsgBox(0x20, 'Did Item One Change?', $oDictionary.Item('One'), 3)<br />
; Remove key<br />
$oDictionary.Remove('One')<br />
; <br />
$oDictionary.Key ('Two') = 'Bike'<br />
EndIf<br />
<br />
Sleep(1000)<br />
<br />
; Store items into a variable<br />
For $vKey In $oDictionary<br />
$sItem &= $oDictionary.Item($vKey) & @CRLF<br />
Next<br />
<br />
; Display items<br />
MsgBox(0x0, 'Items Count: ' & $oDictionary.Count, $sItem, 3)<br />
<br />
; Add items into an array<br />
$aItems = $oDictionary.Items<br />
<br />
; Display items in the array<br />
For $i = 0 To $oDictionary.Count -1<br />
MsgBox(0x0, 'Items [ ' & $i & ' ]', $aItems[$i], 2)<br />
Next<br />
<br />
Sleep(1000)<br />
<br />
; Add keys into an array<br />
$aKeys = $oDictionary.Keys<br />
<br />
; Display keys in the array<br />
For $i = 0 To $oDictionary.Count -1<br />
MsgBox(0x0, 'Keys [ ' & $i & ' ]', $aKeys[$i], 2)<br />
Next<br />
EndIf<br />
</syntaxhighlight><br />
<br /><br />
<br /><br />
The original AutoIt Scripting Dictionary implementation appears to have been by Gary Frost as far back as 2007. It has since been modified to the following:<br />
<br /><br />
<syntaxhighlight lang='autoit'><br />
#cs<br />
Scripting Dictionary UDF<br />
<br />
Made by GaryFrost <https://www.autoitscript.com/forum/topic/47048-scripting-dictionary/><br />
Modified by Jefrey <jefrey[at]jefrey.ml><br />
<br />
Forum https://www.autoitscript.com/forum/topic/182334-scripting-dictionary-modified/<br />
<br />
#ce<br />
<br />
Func _InitDictionary()<br />
Return ObjCreate("Scripting.Dictionary")<br />
EndFunc ;==>_InitDictionary<br />
<br />
; Adds a key and item pair to a Dictionary object.<br />
Func _AddItem($oDictionary, $v_key, $v_item)<br />
$oDictionary.ADD($v_key, $v_item)<br />
If @error Then Return SetError(1, 1, -1)<br />
EndFunc ;==>_AddItem<br />
<br />
; Returns true if a specified key exists in the Dictionary object, false if it does not.<br />
Func _ItemExists($oDictionary, $v_key)<br />
Return $oDictionary.Exists($v_key)<br />
EndFunc ;==>_ItemExists<br />
<br />
; Returns an item for a specified key in a Dictionary object<br />
Func _Item($oDictionary, $v_key)<br />
Return $oDictionary.Item($v_key)<br />
EndFunc ;==>_Item<br />
<br />
; Sets an item for a specified key in a Dictionary object<br />
Func _ChangeItem($oDictionary, $v_key, $v_item)<br />
$oDictionary.Item($v_key) = $v_item<br />
EndFunc ;==>_ChangeItem<br />
<br />
; Sets a key in a Dictionary object.<br />
Func _ChangeKey($oDictionary, $v_key, $v_newKey)<br />
$oDictionary.Key($v_key) = $v_newKey<br />
EndFunc ;==>_ChangeKey<br />
<br />
; Removes a key, item pair from a Dictionary object.<br />
Func _ItemRemove($oDictionary, $v_key)<br />
$oDictionary.Remove($v_key)<br />
If @error Then Return SetError(1, 1, -1)<br />
EndFunc ;==>_ItemRemove<br />
<br />
; Returns the number of items in a collection or Dictionary object.<br />
Func _ItemCount($oDictionary)<br />
Return $oDictionary.Count<br />
EndFunc ;==>_ItemCount<br />
<br />
; Returns an array containing all the items in a Dictionary object<br />
Func _GetItems($oDictionary)<br />
Return $oDictionary.Items<br />
EndFunc ;==>_GetItems<br />
<br />
Func _Clear($oDictionary)<br />
Return $oDictionary.RemoveAll<br />
EndFunc<br />
<br />
</syntaxhighlight><br />
<br /><br />
<br /><br />
Below are several examples that illustrate the usage of the Scripting Dictionary UDF in AutoIt.<br />
<br /><br />
Example 1:<br />
<syntaxhighlight lang='autoit'><br />
; Author Jefrey<br />
; Forum https://www.autoitscript.com/forum/profile/75137-jefrey/<br />
#include 'scriptingdic.au3'<br />
#include <Array.au3> ; Needed only for _ArrayDisplay, and not required by the lib<br />
<br />
; Init the object<br />
$oObj = _InitDictionary()<br />
<br />
; Adding a single value<br />
_AddItem($oObj, 0, "Test")<br />
; And showing it<br />
msgbox(0, '', _Item($oObj, 0))<br />
<br />
; Adding an array<br />
Dim $aArr[] = [0, -80, -49, -44, 80, 100, 8, 7, 6, 5, 4, 3, 2, 1]<br />
_AddItem($oObj, 1, $aArr)<br />
; And showing it<br />
_ArrayDisplay(_Item($oObj, 1))<br />
<br />
; We can also use this approach:<br />
$oObj3 = _InitDictionary()<br />
$oObj.Add("test", "foo")<br />
MsgBox(0, '', $oObj.Item("test"))<br />
</syntaxhighlight><br />
Example 2 is a reply to a common question asked on the Forum, How to find duplicate lines/values... <br />
<syntaxhighlight lang='autoit'><br />
; Author Malkey <br />
; https://www.autoitscript.com/forum/profile/31256-malkey/<br />
; Forum https://www.autoitscript.com/forum/topic/116156-best-way-to-compare-strings-for-duplicates/?do=findComment&comment=810752<br />
Local $sStr, $begin, $dif, $sMatches<br />
<br />
; Create random test data<br />
For $i = 1 To 1000<br />
$sStr &= Chr(Random(Asc("a"), Asc("z"), 1)) & Chr(Random(Asc("a"), Asc("z"), 1)) & _<br />
Chr(Random(Asc("a"), Asc("z"), 1)) & Chr(Random(Asc("a"), Asc("z"), 1)) & @CRLF ;<br />
Next<br />
;ConsoleWrite($sStr & @CRLF)<br />
<br />
$begin = TimerInit()<br />
<br />
Local $oDict = ObjCreate("Scripting.Dictionary") ; to create a dictionary object<br />
Local $aArray = StringSplit(StringStripWS($sStr, 2), @CRLF, 3)<br />
For $i = 0 To UBound($aArray) - 1<br />
If $oDict.Exists($aArray[$i]) Then<br />
$sMatches &= $i & " " & $aArray[$i] & @CRLF ; Record duplicates<br />
Else<br />
$oDict.add($aArray[$i], '') ; to store a string (you may set $value = '' if you have no use of it)<br />
EndIf<br />
Next<br />
$dif = Round(TimerDiff($begin) / 1000, 3) & " secs"<br />
<br />
;Display results<br />
If $sMatches <> "" Then<br />
MsgBox(0, "Results", StringTrimRight($sMatches, 2) & @CRLF & "Time taken = " & $dif)<br />
Else<br />
MsgBox(0, "Results", "No duplicates found" & @CRLF & "Time taken = " & $dif)<br />
EndIf<br />
</syntaxhighlight><br />
<br /><br />
<br /><br /><br />
__________________________________________________________________________<br />
<br /><br />
While the examples above use the Scripting Dictionary method, the example below by guinness does not use the Scripting Dictionary. Also see [https://www.autoitscript.com/forum/topic/59174-associative-array-functions/ this discussion] by Nutster, with Associative Array management tools. <br />
<br />
The next example does not use the scripting dictionary UDF, but makes use of Global Enumerators. This allows access to data through named elements.<br />
<syntaxhighlight lang='autoit'><br />
; Author guinness<br />
; Forum https://www.autoitscript.com/forum/topic/173803-oop-like-approach-in-autoit/<br />
#include <MsgBoxConstants.au3><br />
<br />
; ---- Start of Person Class<br />
<br />
; Stored in the 'object' to verify it's our 'object' and not some random array<br />
Global Const $PERSON_GUID = '4197B285-6AB1-489B-8585-08C852E33F3D'<br />
<br />
; Friendly names for 0, 1, 2 and 3<br />
Global Enum $PERSON_AGE, $PERSON_NAME, $PERSON_ID, $PERSON_MAX<br />
<br />
; Constructor<br />
Func Person($sName, $iAge)<br />
Local $hPerson[$PERSON_MAX]<br />
<br />
; Set the GUID, so as the verification will work<br />
$hPerson[$PERSON_ID] = $PERSON_GUID<br />
<br />
Person_SetAge($hPerson, $iAge)<br />
Person_SetName($hPerson, $sName)<br />
<br />
; Return the Person 'object'<br />
Return $hPerson<br />
EndFunc ;==>Person<br />
<br />
; Getter for the age property<br />
Func Person_GetAge(ByRef $hPerson)<br />
Return _Person_IsObject($hPerson) ? $hPerson[$PERSON_AGE] : Null<br />
EndFunc ;==>Person_GetAge<br />
<br />
; Setter for the age property<br />
Func Person_SetAge(ByRef $hPerson, $iAge)<br />
; If not a valid 'object' or integer then return<br />
If Not _Person_IsObject($hPerson) Or Not IsInt($iAge) Then Return<br />
<br />
; Set the age<br />
$hPerson[$PERSON_AGE] = $iAge<br />
EndFunc ;==>Person_SetAge<br />
<br />
; Getter for the name property<br />
Func Person_GetName(ByRef $hPerson)<br />
Return _Person_IsObject($hPerson) ? $hPerson[$PERSON_NAME] : Null<br />
EndFunc ;==>Person_GetName<br />
<br />
; Setter for the name property<br />
Func Person_SetName(ByRef $hPerson, $sName)<br />
; If not a valid 'object' then return<br />
If Not _Person_IsObject($hPerson) Then Return<br />
<br />
; Set the name<br />
$hPerson[$PERSON_NAME] = $sName<br />
EndFunc ;==>Person_SetName<br />
<br />
; ToString() for the 'object'<br />
Func Person_ToString(ByRef $hPerson)<br />
Return _Person_IsObject($hPerson) ? StringFormat('Name: %s, Age: %i', $hPerson[$PERSON_NAME], $hPerson[$PERSON_AGE]) : Null<br />
EndFunc ;==>Person_ToString<br />
<br />
; Check if it's a valid 'object' and not some random array. "NTERNAL ONLY!<br />
Func _Person_IsObject(ByRef $hPerson)<br />
Return UBound($hPerson) = $PERSON_MAX And $hPerson[$PERSON_ID] == $PERSON_GUID<br />
EndFunc ;==>_Person_IsObject<br />
<br />
; ---- End of Person Class<br />
<br />
Example()<br />
<br />
Func Example()<br />
; Store the Person 'object', which is just a glorified array<br />
Local $hP1 = Person('John', 30)<br />
<br />
; Display the 'object'<br />
MsgBox($MB_SYSTEMMODAL, 'Person 1', Person_ToString($hP1))<br />
<br />
; Create a new person<br />
<br />
; Store the Person 'object', which is just a glorified array<br />
Local $hP2 = Person('James', 36)<br />
<br />
; Display the 'object'<br />
MsgBox($MB_SYSTEMMODAL, 'Person 2', Person_ToString($hP2))<br />
<br />
; Set the age for Person 2<br />
Person_SetAge($hP2, 45)<br />
<br />
; Display the 'object'<br />
MsgBox($MB_SYSTEMMODAL, 'Person 2 - Revised', Person_ToString($hP2))<br />
EndFunc ;==>Example<br />
</syntaxhighlight><br />
Please see the current beta for more information on map functions.<br />
<syntaxhighlight lang='autoit'><br />
</syntaxhighlight></div>Skysnakehttps://www.autoitscript.com/w/index.php?title=Associative_Arrays&diff=13729Associative Arrays2017-11-30T10:31:06Z<p>Skysnake: </p>
<hr />
<div>In computer science, an associative array, map, symbol table, or dictionary is an abstract data type composed of a collection of (key, value) pairs, such that each possible key appears at most once in the collection.<br />
An associative array differs from a “normal” array in one major way: rather than being indexed numerically (i.e. 0, 1, 2, 3, …), it is indexed by a key, or a language-like word. <br />
A '''Scripting.Dictionary''' is a standard object provided by the '''Microsoft Scripting Runtime''' (scrrun.dll) dependency and is commonly used in VBScript, a reference to which needs to be added in order to create an object in your AutoIt project.<br />
<br /><br />
<br /><br />
This discussion by '''Nutster''' explains the [https://www.autoitscript.com/forum/topic/59174-associative-array-functions/#comment-445963 original implementation] of Associative Arrays in AutoIt. <br />
An associative array is an array where the keys (index numbers) are string instead of integer, as they are in AutoIt. Linux / Unix awk and perl use associative arrays by default. The following functions can be used to manage a version of associative arrays in single AutoIt variables. A hash table is used to store the values because it is faster to insert than other options I can think of and pretty much as fast as them to retrieve the data. The memory requirements are a little higher than other methods, but I think it is a reasonable trade-off. It uses a simple hash function that can probably be easily improved upon and while it can resize the hash table, the resize is slow so try to make your initial size large enough for all your elements. Please see the Include file and an exerciser that demonstrates how to use the associative array functions. Read the comments at the top of each function for more details on their use.<br />
<br /><br />
<br /><br />
<big>Note:</big><br />
<br /><br />
AutoIt allows for at least two different implementations of Associative Arrays. The first method relies on AutoIt internally processing named array elements. The second method makes use of the Scripting Dictionary. <br /><br />
<br />
<br /><br />
<br />
A few notes on Associative Arrays:<br /><br />
* Think of an associative array as an array with named elements<br />
* Comparisons can be exact (binary) or case insensitive (alpha)<br />
<br /><br /><br />
At the time of writing this - 28 November 2017 - a new '''map data type''' is under development for AutoIt. It is availabe in the current [https://www.autoitscript.com/forum/topic/163657-maps-beta/?do=findComment&comment=1296278 beta release].<br />
<br /><br />
<br /><br />
Please also see this entry in the Snippets section of this Wiki [https://www.autoitscript.com/wiki/Snippets_(_AutoIt_Array_)#AssocArray _AssocArray] <br />
<br /><br />
<br /><br />
<br />
A dictionary object example by [https://www.autoitscript.com/forum/profile/2709-mhz/ MHz]<br />
<syntaxhighlight lang='autoit'><br />
; Author Mhz<br />
; Forum https://www.autoitscript.com/forum/topic/182334-scripting-dictionary-modified/<br />
Global $vKey, $sItem, $sMsg, $oDictionary <br />
<br />
; Create dictionary object<br />
$oDictionary = ObjCreate("Scripting.Dictionary")<br />
<br />
If @error Then<br />
MsgBox(0, '', 'Error creating the dictionary object')<br />
Else<br />
; Add keys with items<br />
$oDictionary.Add ("One", "Same" )<br />
$oDictionary.Add ("Two", "Car" )<br />
$oDictionary.Add ("Three", "House" )<br />
$oDictionary.Add ("Four", "Boat" )<br />
<br />
If $oDictionary.Exists('One') Then<br />
; Display item<br />
MsgBox(0x0, 'Item One', $oDictionary.Item('One'), 2)<br />
; Set an item<br />
$oDictionary.Item('One') = 'Changed'<br />
; Display item<br />
MsgBox(0x20, 'Did Item One Change?', $oDictionary.Item('One'), 3)<br />
; Remove key<br />
$oDictionary.Remove('One')<br />
; <br />
$oDictionary.Key ('Two') = 'Bike'<br />
EndIf<br />
<br />
Sleep(1000)<br />
<br />
; Store items into a variable<br />
For $vKey In $oDictionary<br />
$sItem &= $oDictionary.Item($vKey) & @CRLF<br />
Next<br />
<br />
; Display items<br />
MsgBox(0x0, 'Items Count: ' & $oDictionary.Count, $sItem, 3)<br />
<br />
; Add items into an array<br />
$aItems = $oDictionary.Items<br />
<br />
; Display items in the array<br />
For $i = 0 To $oDictionary.Count -1<br />
MsgBox(0x0, 'Items [ ' & $i & ' ]', $aItems[$i], 2)<br />
Next<br />
<br />
Sleep(1000)<br />
<br />
; Add keys into an array<br />
$aKeys = $oDictionary.Keys<br />
<br />
; Display keys in the array<br />
For $i = 0 To $oDictionary.Count -1<br />
MsgBox(0x0, 'Keys [ ' & $i & ' ]', $aKeys[$i], 2)<br />
Next<br />
EndIf<br />
</syntaxhighlight><br />
<br /><br />
<br /><br />
The original AutoIt Scripting Dictionary implementation appears to have been by Gary Frost as far back as 2007. It has since been modified to the following:<br />
<br /><br />
<syntaxhighlight lang='autoit'><br />
#cs<br />
Scripting Dictionary UDF<br />
<br />
Made by GaryFrost <https://www.autoitscript.com/forum/topic/47048-scripting-dictionary/><br />
Modified by Jefrey <jefrey[at]jefrey.ml><br />
<br />
Forum https://www.autoitscript.com/forum/topic/182334-scripting-dictionary-modified/<br />
<br />
#ce<br />
<br />
Func _InitDictionary()<br />
Return ObjCreate("Scripting.Dictionary")<br />
EndFunc ;==>_InitDictionary<br />
<br />
; Adds a key and item pair to a Dictionary object.<br />
Func _AddItem($oDictionary, $v_key, $v_item)<br />
$oDictionary.ADD($v_key, $v_item)<br />
If @error Then Return SetError(1, 1, -1)<br />
EndFunc ;==>_AddItem<br />
<br />
; Returns true if a specified key exists in the Dictionary object, false if it does not.<br />
Func _ItemExists($oDictionary, $v_key)<br />
Return $oDictionary.Exists($v_key)<br />
EndFunc ;==>_ItemExists<br />
<br />
; Returns an item for a specified key in a Dictionary object<br />
Func _Item($oDictionary, $v_key)<br />
Return $oDictionary.Item($v_key)<br />
EndFunc ;==>_Item<br />
<br />
; Sets an item for a specified key in a Dictionary object<br />
Func _ChangeItem($oDictionary, $v_key, $v_item)<br />
$oDictionary.Item($v_key) = $v_item<br />
EndFunc ;==>_ChangeItem<br />
<br />
; Sets a key in a Dictionary object.<br />
Func _ChangeKey($oDictionary, $v_key, $v_newKey)<br />
$oDictionary.Key($v_key) = $v_newKey<br />
EndFunc ;==>_ChangeKey<br />
<br />
; Removes a key, item pair from a Dictionary object.<br />
Func _ItemRemove($oDictionary, $v_key)<br />
$oDictionary.Remove($v_key)<br />
If @error Then Return SetError(1, 1, -1)<br />
EndFunc ;==>_ItemRemove<br />
<br />
; Returns the number of items in a collection or Dictionary object.<br />
Func _ItemCount($oDictionary)<br />
Return $oDictionary.Count<br />
EndFunc ;==>_ItemCount<br />
<br />
; Returns an array containing all the items in a Dictionary object<br />
Func _GetItems($oDictionary)<br />
Return $oDictionary.Items<br />
EndFunc ;==>_GetItems<br />
<br />
Func _Clear($oDictionary)<br />
Return $oDictionary.RemoveAll<br />
EndFunc<br />
<br />
</syntaxhighlight><br />
<br /><br />
<br /><br />
Below are several examples that illustrate the usage of the Scripting Dictionary UDF in AutoIt.<br />
<br /><br />
Example 1:<br />
<syntaxhighlight lang='autoit'><br />
; Author Jefrey<br />
; Forum https://www.autoitscript.com/forum/profile/75137-jefrey/<br />
#include 'scriptingdic.au3'<br />
#include <Array.au3> ; Needed only for _ArrayDisplay, and not required by the lib<br />
<br />
; Init the object<br />
$oObj = _InitDictionary()<br />
<br />
; Adding a single value<br />
_AddItem($oObj, 0, "Test")<br />
; And showing it<br />
msgbox(0, '', _Item($oObj, 0))<br />
<br />
; Adding an array<br />
Dim $aArr[] = [0, -80, -49, -44, 80, 100, 8, 7, 6, 5, 4, 3, 2, 1]<br />
_AddItem($oObj, 1, $aArr)<br />
; And showing it<br />
_ArrayDisplay(_Item($oObj, 1))<br />
<br />
; We can also use this approach:<br />
$oObj3 = _InitDictionary()<br />
$oObj.Add("test", "foo")<br />
MsgBox(0, '', $oObj.Item("test"))<br />
</syntaxhighlight><br />
Example 2 is a reply to a common question asked on the Forum, How to find duplicate lines/values... <br />
<syntaxhighlight lang='autoit'><br />
; Author Malkey <br />
; https://www.autoitscript.com/forum/profile/31256-malkey/<br />
; Forum https://www.autoitscript.com/forum/topic/116156-best-way-to-compare-strings-for-duplicates/?do=findComment&comment=810752<br />
Local $sStr, $begin, $dif, $sMatches<br />
<br />
; Create random test data<br />
For $i = 1 To 1000<br />
$sStr &= Chr(Random(Asc("a"), Asc("z"), 1)) & Chr(Random(Asc("a"), Asc("z"), 1)) & _<br />
Chr(Random(Asc("a"), Asc("z"), 1)) & Chr(Random(Asc("a"), Asc("z"), 1)) & @CRLF ;<br />
Next<br />
;ConsoleWrite($sStr & @CRLF)<br />
<br />
$begin = TimerInit()<br />
<br />
Local $oDict = ObjCreate("Scripting.Dictionary") ; to create a dictionary object<br />
Local $aArray = StringSplit(StringStripWS($sStr, 2), @CRLF, 3)<br />
For $i = 0 To UBound($aArray) - 1<br />
If $oDict.Exists($aArray[$i]) Then<br />
$sMatches &= $i & " " & $aArray[$i] & @CRLF ; Record duplicates<br />
Else<br />
$oDict.add($aArray[$i], '') ; to store a string (you may set $value = '' if you have no use of it)<br />
EndIf<br />
Next<br />
$dif = Round(TimerDiff($begin) / 1000, 3) & " secs"<br />
<br />
;Display results<br />
If $sMatches <> "" Then<br />
MsgBox(0, "Results", StringTrimRight($sMatches, 2) & @CRLF & "Time taken = " & $dif)<br />
Else<br />
MsgBox(0, "Results", "No duplicates found" & @CRLF & "Time taken = " & $dif)<br />
EndIf<br />
</syntaxhighlight><br />
<br /><br />
<br /><br /><br />
__________________________________________________________________________<br />
<br /><br />
While the examples above use the Scripting Dictionary method, the example below by guinness does not use the Scripting Dictionary. Also see [https://www.autoitscript.com/forum/topic/59174-associative-array-functions/ this discussion] by Nutster, with Associative Array management tools. <br />
<br />
The next example does not use the scripting dictionary UDF, but makes use of Global Enumerators. This allows access to data through named elements.<br />
<syntaxhighlight lang='autoit'><br />
; Author guinness<br />
; Forum https://www.autoitscript.com/forum/topic/173803-oop-like-approach-in-autoit/<br />
#include <MsgBoxConstants.au3><br />
<br />
; ---- Start of Person Class<br />
<br />
; Stored in the 'object' to verify it's our 'object' and not some random array<br />
Global Const $PERSON_GUID = '4197B285-6AB1-489B-8585-08C852E33F3D'<br />
<br />
; Friendly names for 0, 1, 2 and 3<br />
Global Enum $PERSON_AGE, $PERSON_NAME, $PERSON_ID, $PERSON_MAX<br />
<br />
; Constructor<br />
Func Person($sName, $iAge)<br />
Local $hPerson[$PERSON_MAX]<br />
<br />
; Set the GUID, so as the verification will work<br />
$hPerson[$PERSON_ID] = $PERSON_GUID<br />
<br />
Person_SetAge($hPerson, $iAge)<br />
Person_SetName($hPerson, $sName)<br />
<br />
; Return the Person 'object'<br />
Return $hPerson<br />
EndFunc ;==>Person<br />
<br />
; Getter for the age property<br />
Func Person_GetAge(ByRef $hPerson)<br />
Return _Person_IsObject($hPerson) ? $hPerson[$PERSON_AGE] : Null<br />
EndFunc ;==>Person_GetAge<br />
<br />
; Setter for the age property<br />
Func Person_SetAge(ByRef $hPerson, $iAge)<br />
; If not a valid 'object' or integer then return<br />
If Not _Person_IsObject($hPerson) Or Not IsInt($iAge) Then Return<br />
<br />
; Set the age<br />
$hPerson[$PERSON_AGE] = $iAge<br />
EndFunc ;==>Person_SetAge<br />
<br />
; Getter for the name property<br />
Func Person_GetName(ByRef $hPerson)<br />
Return _Person_IsObject($hPerson) ? $hPerson[$PERSON_NAME] : Null<br />
EndFunc ;==>Person_GetName<br />
<br />
; Setter for the name property<br />
Func Person_SetName(ByRef $hPerson, $sName)<br />
; If not a valid 'object' then return<br />
If Not _Person_IsObject($hPerson) Then Return<br />
<br />
; Set the name<br />
$hPerson[$PERSON_NAME] = $sName<br />
EndFunc ;==>Person_SetName<br />
<br />
; ToString() for the 'object'<br />
Func Person_ToString(ByRef $hPerson)<br />
Return _Person_IsObject($hPerson) ? StringFormat('Name: %s, Age: %i', $hPerson[$PERSON_NAME], $hPerson[$PERSON_AGE]) : Null<br />
EndFunc ;==>Person_ToString<br />
<br />
; Check if it's a valid 'object' and not some random array. "NTERNAL ONLY!<br />
Func _Person_IsObject(ByRef $hPerson)<br />
Return UBound($hPerson) = $PERSON_MAX And $hPerson[$PERSON_ID] == $PERSON_GUID<br />
EndFunc ;==>_Person_IsObject<br />
<br />
; ---- End of Person Class<br />
<br />
Example()<br />
<br />
Func Example()<br />
; Store the Person 'object', which is just a glorified array<br />
Local $hP1 = Person('John', 30)<br />
<br />
; Display the 'object'<br />
MsgBox($MB_SYSTEMMODAL, 'Person 1', Person_ToString($hP1))<br />
<br />
; Create a new person<br />
<br />
; Store the Person 'object', which is just a glorified array<br />
Local $hP2 = Person('James', 36)<br />
<br />
; Display the 'object'<br />
MsgBox($MB_SYSTEMMODAL, 'Person 2', Person_ToString($hP2))<br />
<br />
; Set the age for Person 2<br />
Person_SetAge($hP2, 45)<br />
<br />
; Display the 'object'<br />
MsgBox($MB_SYSTEMMODAL, 'Person 2 - Revised', Person_ToString($hP2))<br />
EndFunc ;==>Example<br />
</syntaxhighlight><br />
Please see the current beta for more information on map functions.<br />
<syntaxhighlight lang='autoit'><br />
</syntaxhighlight></div>Skysnakehttps://www.autoitscript.com/w/index.php?title=Associative_Arrays&diff=13728Associative Arrays2017-11-30T10:24:28Z<p>Skysnake: </p>
<hr />
<div>In computer science, an associative array, map, symbol table, or dictionary is an abstract data type composed of a collection of (key, value) pairs, such that each possible key appears at most once in the collection.<br />
An associative array differs from a “normal” array in one major way: rather than being indexed numerically (i.e. 0, 1, 2, 3, …), it is indexed by a key, or a language-like word. <br />
A '''Scripting.Dictionary''' is a standard object provided by the '''Microsoft Scripting Runtime''' (scrrun.dll) dependency and is commonly used in VBScript, a reference to which needs to be added in order to create an object in your AutoIt project.<br />
<br /><br />
<br /><br />
This discussion by '''Nutster''' explains the [https://www.autoitscript.com/forum/topic/59174-associative-array-functions/#comment-445963 original implementation] of Associative Arrays in AutoIt. <br />
An associative array is an array where the keys (index numbers) are string instead of integer, as they are in AutoIt. Linux / Unix awk and perl use associative arrays by default. The following functions can be used to manage a version of associative arrays in single AutoIt variables. A hash table is used to store the values because it is faster to insert than other options I can think of and pretty much as fast as them to retrieve the data. The memory requirements are a little higher than other methods, but I think it is a reasonable trade-off. It uses a simple hash function that can probably be easily improved upon and while it can resize the hash table, the resize is slow so try to make your initial size large enough for all your elements. Please see the Include file and an exerciser that demonstrates how to use the associative array functions. Read the comments at the top of each function for more details on their use.<br />
<br /><br />
<br /><br />
<big>Note:</big><br />
<br /><br />
AutoIt allows for at least two different implementations of Associative Arrays. The first method relies on AutoIt internally processing named array elements. The second method makes use of the Scripting Dictionary. <br /><br />
<br />
<br /><br />
<br />
A few notes on Associative Arrays:<br /><br />
* Think of an associative array as an array with named elements<br />
* Comparisons can be exact (binary) or case insensitive (alpha)<br />
<br /><br /><br />
At the time of writing this - 28 November 2017 - a new '''map data type''' is under development for AutoIt. It is availabe in the current [https://www.autoitscript.com/forum/topic/163657-maps-beta/?do=findComment&comment=1296278 beta release].<br />
<br /><br />
<br /><br />
Please also see this entry in the Snippets section of this Wiki [https://www.autoitscript.com/wiki/Snippets_(_AutoIt_Array_)#AssocArray _AssocArray] <br />
<br /><br />
<br /><br />
<br />
A dictionary object example by [https://www.autoitscript.com/forum/profile/2709-mhz/ MHz]<br />
<syntaxhighlight lang='autoit'><br />
; Author Mhz<br />
; Forum https://www.autoitscript.com/forum/topic/182334-scripting-dictionary-modified/<br />
Global $vKey, $sItem, $sMsg, $oDictionary <br />
<br />
; Create dictionary object<br />
$oDictionary = ObjCreate("Scripting.Dictionary")<br />
<br />
If @error Then<br />
MsgBox(0, '', 'Error creating the dictionary object')<br />
Else<br />
; Add keys with items<br />
$oDictionary.Add ("One", "Same" )<br />
$oDictionary.Add ("Two", "Car" )<br />
$oDictionary.Add ("Three", "House" )<br />
$oDictionary.Add ("Four", "Boat" )<br />
<br />
If $oDictionary.Exists('One') Then<br />
; Display item<br />
MsgBox(0x0, 'Item One', $oDictionary.Item('One'), 2)<br />
; Set an item<br />
$oDictionary.Item('One') = 'Changed'<br />
; Display item<br />
MsgBox(0x20, 'Did Item One Change?', $oDictionary.Item('One'), 3)<br />
; Remove key<br />
$oDictionary.Remove('One')<br />
; <br />
$oDictionary.Key ('Two') = 'Bike'<br />
EndIf<br />
<br />
Sleep(1000)<br />
<br />
; Store items into a variable<br />
For $vKey In $oDictionary<br />
$sItem &= $oDictionary.Item($vKey) & @CRLF<br />
Next<br />
<br />
; Display items<br />
MsgBox(0x0, 'Items Count: ' & $oDictionary.Count, $sItem, 3)<br />
<br />
; Add items into an array<br />
$aItems = $oDictionary.Items<br />
<br />
; Display items in the array<br />
For $i = 0 To $oDictionary.Count -1<br />
MsgBox(0x0, 'Items [ ' & $i & ' ]', $aItems[$i], 2)<br />
Next<br />
<br />
Sleep(1000)<br />
<br />
; Add keys into an array<br />
$aKeys = $oDictionary.Keys<br />
<br />
; Display keys in the array<br />
For $i = 0 To $oDictionary.Count -1<br />
MsgBox(0x0, 'Keys [ ' & $i & ' ]', $aKeys[$i], 2)<br />
Next<br />
EndIf<br />
</syntaxhighlight><br />
<br /><br />
<br /><br />
The original AutoIt Scripting Dictionary implementation appears to have been by Gary Frost as far back as 2007. It has since been modified to the following:<br />
<br /><br />
<syntaxhighlight lang='autoit'><br />
#cs<br />
Scripting Dictionary UDF<br />
<br />
Made by GaryFrost <https://www.autoitscript.com/forum/topic/47048-scripting-dictionary/><br />
Modified by Jefrey <jefrey[at]jefrey.ml><br />
<br />
Forum https://www.autoitscript.com/forum/topic/182334-scripting-dictionary-modified/<br />
<br />
#ce<br />
<br />
Func _InitDictionary()<br />
Return ObjCreate("Scripting.Dictionary")<br />
EndFunc ;==>_InitDictionary<br />
<br />
; Adds a key and item pair to a Dictionary object.<br />
Func _AddItem($oDictionary, $v_key, $v_item)<br />
$oDictionary.ADD($v_key, $v_item)<br />
If @error Then Return SetError(1, 1, -1)<br />
EndFunc ;==>_AddItem<br />
<br />
; Returns true if a specified key exists in the Dictionary object, false if it does not.<br />
Func _ItemExists($oDictionary, $v_key)<br />
Return $oDictionary.Exists($v_key)<br />
EndFunc ;==>_ItemExists<br />
<br />
; Returns an item for a specified key in a Dictionary object<br />
Func _Item($oDictionary, $v_key)<br />
Return $oDictionary.Item($v_key)<br />
EndFunc ;==>_Item<br />
<br />
; Sets an item for a specified key in a Dictionary object<br />
Func _ChangeItem($oDictionary, $v_key, $v_item)<br />
$oDictionary.Item($v_key) = $v_item<br />
EndFunc ;==>_ChangeItem<br />
<br />
; Sets a key in a Dictionary object.<br />
Func _ChangeKey($oDictionary, $v_key, $v_newKey)<br />
$oDictionary.Key($v_key) = $v_newKey<br />
EndFunc ;==>_ChangeKey<br />
<br />
; Removes a key, item pair from a Dictionary object.<br />
Func _ItemRemove($oDictionary, $v_key)<br />
$oDictionary.Remove($v_key)<br />
If @error Then Return SetError(1, 1, -1)<br />
EndFunc ;==>_ItemRemove<br />
<br />
; Returns the number of items in a collection or Dictionary object.<br />
Func _ItemCount($oDictionary)<br />
Return $oDictionary.Count<br />
EndFunc ;==>_ItemCount<br />
<br />
; Returns an array containing all the items in a Dictionary object<br />
Func _GetItems($oDictionary)<br />
Return $oDictionary.Items<br />
EndFunc ;==>_GetItems<br />
<br />
Func _Clear($oDictionary)<br />
Return $oDictionary.RemoveAll<br />
EndFunc<br />
<br />
</syntaxhighlight><br />
<br /><br />
<br /><br />
Below are several examples that illustrate the usage of the Scripting Dictionary UDF in AutoIt.<br />
<br /><br />
Example 1:<br />
<syntaxhighlight lang='autoit'><br />
; Author Jefrey<br />
; Forum https://www.autoitscript.com/forum/profile/75137-jefrey/<br />
#include 'scriptingdic.au3'<br />
#include <Array.au3> ; Needed only for _ArrayDisplay, and not required by the lib<br />
<br />
; Init the object<br />
$oObj = _InitDictionary()<br />
<br />
; Adding a single value<br />
_AddItem($oObj, 0, "Test")<br />
; And showing it<br />
msgbox(0, '', _Item($oObj, 0))<br />
<br />
; Adding an array<br />
Dim $aArr[] = [0, -80, -49, -44, 80, 100, 8, 7, 6, 5, 4, 3, 2, 1]<br />
_AddItem($oObj, 1, $aArr)<br />
; And showing it<br />
_ArrayDisplay(_Item($oObj, 1))<br />
<br />
; We can also use this approach:<br />
$oObj3 = _InitDictionary()<br />
$oObj.Add("test", "foo")<br />
MsgBox(0, '', $oObj.Item("test"))<br />
</syntaxhighlight><br />
Example 2 is a reply to a common question asked on the Forum, How to find duplicate lines/values... <br />
<syntaxhighlight lang='autoit'><br />
; Author Malkey <br />
; https://www.autoitscript.com/forum/profile/31256-malkey/<br />
; Forum https://www.autoitscript.com/forum/topic/116156-best-way-to-compare-strings-for-duplicates/?do=findComment&comment=810752<br />
Local $sStr, $begin, $dif, $sMatches<br />
<br />
; Create random test data<br />
For $i = 1 To 1000<br />
$sStr &= Chr(Random(Asc("a"), Asc("z"), 1)) & Chr(Random(Asc("a"), Asc("z"), 1)) & _<br />
Chr(Random(Asc("a"), Asc("z"), 1)) & Chr(Random(Asc("a"), Asc("z"), 1)) & @CRLF ;<br />
Next<br />
;ConsoleWrite($sStr & @CRLF)<br />
<br />
$begin = TimerInit()<br />
<br />
Local $oDict = ObjCreate("Scripting.Dictionary") ; to create a dictionary object<br />
Local $aArray = StringSplit(StringStripWS($sStr, 2), @CRLF, 3)<br />
For $i = 0 To UBound($aArray) - 1<br />
If $oDict.Exists($aArray[$i]) Then<br />
$sMatches &= $i & " " & $aArray[$i] & @CRLF ; Record duplicates<br />
Else<br />
$oDict.add($aArray[$i], '') ; to store a string (you may set $value = '' if you have no use of it)<br />
EndIf<br />
Next<br />
$dif = Round(TimerDiff($begin) / 1000, 3) & " secs"<br />
<br />
;Display results<br />
If $sMatches <> "" Then<br />
MsgBox(0, "Results", StringTrimRight($sMatches, 2) & @CRLF & "Time taken = " & $dif)<br />
Else<br />
MsgBox(0, "Results", "No duplicates found" & @CRLF & "Time taken = " & $dif)<br />
EndIf<br />
</syntaxhighlight><br />
<br /><br />
<br /><br /><br />
_____________________________________________________<br />
<br /><br />
<br />
The next example does not use the scripting dictionary UDF, but makes use of Global Enumerators. This allows access to data through named elements.<br />
<syntaxhighlight lang='autoit'><br />
; Author guinness<br />
; Forum https://www.autoitscript.com/forum/topic/173803-oop-like-approach-in-autoit/<br />
#include <MsgBoxConstants.au3><br />
<br />
; ---- Start of Person Class<br />
<br />
; Stored in the 'object' to verify it's our 'object' and not some random array<br />
Global Const $PERSON_GUID = '4197B285-6AB1-489B-8585-08C852E33F3D'<br />
<br />
; Friendly names for 0, 1, 2 and 3<br />
Global Enum $PERSON_AGE, $PERSON_NAME, $PERSON_ID, $PERSON_MAX<br />
<br />
; Constructor<br />
Func Person($sName, $iAge)<br />
Local $hPerson[$PERSON_MAX]<br />
<br />
; Set the GUID, so as the verification will work<br />
$hPerson[$PERSON_ID] = $PERSON_GUID<br />
<br />
Person_SetAge($hPerson, $iAge)<br />
Person_SetName($hPerson, $sName)<br />
<br />
; Return the Person 'object'<br />
Return $hPerson<br />
EndFunc ;==>Person<br />
<br />
; Getter for the age property<br />
Func Person_GetAge(ByRef $hPerson)<br />
Return _Person_IsObject($hPerson) ? $hPerson[$PERSON_AGE] : Null<br />
EndFunc ;==>Person_GetAge<br />
<br />
; Setter for the age property<br />
Func Person_SetAge(ByRef $hPerson, $iAge)<br />
; If not a valid 'object' or integer then return<br />
If Not _Person_IsObject($hPerson) Or Not IsInt($iAge) Then Return<br />
<br />
; Set the age<br />
$hPerson[$PERSON_AGE] = $iAge<br />
EndFunc ;==>Person_SetAge<br />
<br />
; Getter for the name property<br />
Func Person_GetName(ByRef $hPerson)<br />
Return _Person_IsObject($hPerson) ? $hPerson[$PERSON_NAME] : Null<br />
EndFunc ;==>Person_GetName<br />
<br />
; Setter for the name property<br />
Func Person_SetName(ByRef $hPerson, $sName)<br />
; If not a valid 'object' then return<br />
If Not _Person_IsObject($hPerson) Then Return<br />
<br />
; Set the name<br />
$hPerson[$PERSON_NAME] = $sName<br />
EndFunc ;==>Person_SetName<br />
<br />
; ToString() for the 'object'<br />
Func Person_ToString(ByRef $hPerson)<br />
Return _Person_IsObject($hPerson) ? StringFormat('Name: %s, Age: %i', $hPerson[$PERSON_NAME], $hPerson[$PERSON_AGE]) : Null<br />
EndFunc ;==>Person_ToString<br />
<br />
; Check if it's a valid 'object' and not some random array. "NTERNAL ONLY!<br />
Func _Person_IsObject(ByRef $hPerson)<br />
Return UBound($hPerson) = $PERSON_MAX And $hPerson[$PERSON_ID] == $PERSON_GUID<br />
EndFunc ;==>_Person_IsObject<br />
<br />
; ---- End of Person Class<br />
<br />
Example()<br />
<br />
Func Example()<br />
; Store the Person 'object', which is just a glorified array<br />
Local $hP1 = Person('John', 30)<br />
<br />
; Display the 'object'<br />
MsgBox($MB_SYSTEMMODAL, 'Person 1', Person_ToString($hP1))<br />
<br />
; Create a new person<br />
<br />
; Store the Person 'object', which is just a glorified array<br />
Local $hP2 = Person('James', 36)<br />
<br />
; Display the 'object'<br />
MsgBox($MB_SYSTEMMODAL, 'Person 2', Person_ToString($hP2))<br />
<br />
; Set the age for Person 2<br />
Person_SetAge($hP2, 45)<br />
<br />
; Display the 'object'<br />
MsgBox($MB_SYSTEMMODAL, 'Person 2 - Revised', Person_ToString($hP2))<br />
EndFunc ;==>Example<br />
</syntaxhighlight><br />
Please see the current beta for more information on map functions.<br />
<syntaxhighlight lang='autoit'><br />
</syntaxhighlight></div>Skysnakehttps://www.autoitscript.com/w/index.php?title=Associative_Arrays&diff=13727Associative Arrays2017-11-30T10:23:57Z<p>Skysnake: </p>
<hr />
<div>In computer science, an associative array, map, symbol table, or dictionary is an abstract data type composed of a collection of (key, value) pairs, such that each possible key appears at most once in the collection.<br />
An associative array differs from a “normal” array in one major way: rather than being indexed numerically (i.e. 0, 1, 2, 3, …), it is indexed by a key, or a language-like word. <br />
A '''Scripting.Dictionary''' is a standard object provided by the '''Microsoft Scripting Runtime''' (scrrun.dll) dependency and is commonly used in VBScript, a reference to which needs to be added in order to create an object in your AutoIt project.<br />
<br /><br />
<br /><br />
This discussion by '''Nutster''' explains the [https://www.autoitscript.com/forum/topic/59174-associative-array-functions/#comment-445963 original implementation] of Associative Arrays in AutoIt. <br />
An associative array is an array where the keys (index numbers) are string instead of integer, as they are in AutoIt. Linux / Unix awk and perl use associative arrays by default. The following functions can be used to manage a version of associative arrays in single AutoIt variables. A hash table is used to store the values because it is faster to insert than other options I can think of and pretty much as fast as them to retrieve the data. The memory requirements are a little higher than other methods, but I think it is a reasonable trade-off. It uses a simple hash function that can probably be easily improved upon and while it can resize the hash table, the resize is slow so try to make your initial size large enough for all your elements. Please see the Include file and an exerciser that demonstrates how to use the associative array functions. Read the comments at the top of each function for more details on their use.<br />
<br /><br />
<br /<big>>Note:</big><br /><br />
AutoIt allows for at least two different implementations of Associative Arrays. The first method relies on AutoIt internally processing named array elements. The second method makes use of the Scripting Dictionary. <br /><br />
<br />
<br /><br />
<br />
A few notes on Associative Arrays:<br /><br />
* Think of an associative array as an array with named elements<br />
* Comparisons can be exact (binary) or case insensitive (alpha)<br />
<br /><br /><br />
At the time of writing this - 28 November 2017 - a new '''map data type''' is under development for AutoIt. It is availabe in the current [https://www.autoitscript.com/forum/topic/163657-maps-beta/?do=findComment&comment=1296278 beta release].<br />
<br /><br />
<br /><br />
Please also see this entry in the Snippets section of this Wiki [https://www.autoitscript.com/wiki/Snippets_(_AutoIt_Array_)#AssocArray _AssocArray] <br />
<br /><br />
<br /><br />
<br />
A dictionary object example by [https://www.autoitscript.com/forum/profile/2709-mhz/ MHz]<br />
<syntaxhighlight lang='autoit'><br />
; Author Mhz<br />
; Forum https://www.autoitscript.com/forum/topic/182334-scripting-dictionary-modified/<br />
Global $vKey, $sItem, $sMsg, $oDictionary <br />
<br />
; Create dictionary object<br />
$oDictionary = ObjCreate("Scripting.Dictionary")<br />
<br />
If @error Then<br />
MsgBox(0, '', 'Error creating the dictionary object')<br />
Else<br />
; Add keys with items<br />
$oDictionary.Add ("One", "Same" )<br />
$oDictionary.Add ("Two", "Car" )<br />
$oDictionary.Add ("Three", "House" )<br />
$oDictionary.Add ("Four", "Boat" )<br />
<br />
If $oDictionary.Exists('One') Then<br />
; Display item<br />
MsgBox(0x0, 'Item One', $oDictionary.Item('One'), 2)<br />
; Set an item<br />
$oDictionary.Item('One') = 'Changed'<br />
; Display item<br />
MsgBox(0x20, 'Did Item One Change?', $oDictionary.Item('One'), 3)<br />
; Remove key<br />
$oDictionary.Remove('One')<br />
; <br />
$oDictionary.Key ('Two') = 'Bike'<br />
EndIf<br />
<br />
Sleep(1000)<br />
<br />
; Store items into a variable<br />
For $vKey In $oDictionary<br />
$sItem &= $oDictionary.Item($vKey) & @CRLF<br />
Next<br />
<br />
; Display items<br />
MsgBox(0x0, 'Items Count: ' & $oDictionary.Count, $sItem, 3)<br />
<br />
; Add items into an array<br />
$aItems = $oDictionary.Items<br />
<br />
; Display items in the array<br />
For $i = 0 To $oDictionary.Count -1<br />
MsgBox(0x0, 'Items [ ' & $i & ' ]', $aItems[$i], 2)<br />
Next<br />
<br />
Sleep(1000)<br />
<br />
; Add keys into an array<br />
$aKeys = $oDictionary.Keys<br />
<br />
; Display keys in the array<br />
For $i = 0 To $oDictionary.Count -1<br />
MsgBox(0x0, 'Keys [ ' & $i & ' ]', $aKeys[$i], 2)<br />
Next<br />
EndIf<br />
</syntaxhighlight><br />
<br /><br />
<br /><br />
The original AutoIt Scripting Dictionary implementation appears to have been by Gary Frost as far back as 2007. It has since been modified to the following:<br />
<br /><br />
<syntaxhighlight lang='autoit'><br />
#cs<br />
Scripting Dictionary UDF<br />
<br />
Made by GaryFrost <https://www.autoitscript.com/forum/topic/47048-scripting-dictionary/><br />
Modified by Jefrey <jefrey[at]jefrey.ml><br />
<br />
Forum https://www.autoitscript.com/forum/topic/182334-scripting-dictionary-modified/<br />
<br />
#ce<br />
<br />
Func _InitDictionary()<br />
Return ObjCreate("Scripting.Dictionary")<br />
EndFunc ;==>_InitDictionary<br />
<br />
; Adds a key and item pair to a Dictionary object.<br />
Func _AddItem($oDictionary, $v_key, $v_item)<br />
$oDictionary.ADD($v_key, $v_item)<br />
If @error Then Return SetError(1, 1, -1)<br />
EndFunc ;==>_AddItem<br />
<br />
; Returns true if a specified key exists in the Dictionary object, false if it does not.<br />
Func _ItemExists($oDictionary, $v_key)<br />
Return $oDictionary.Exists($v_key)<br />
EndFunc ;==>_ItemExists<br />
<br />
; Returns an item for a specified key in a Dictionary object<br />
Func _Item($oDictionary, $v_key)<br />
Return $oDictionary.Item($v_key)<br />
EndFunc ;==>_Item<br />
<br />
; Sets an item for a specified key in a Dictionary object<br />
Func _ChangeItem($oDictionary, $v_key, $v_item)<br />
$oDictionary.Item($v_key) = $v_item<br />
EndFunc ;==>_ChangeItem<br />
<br />
; Sets a key in a Dictionary object.<br />
Func _ChangeKey($oDictionary, $v_key, $v_newKey)<br />
$oDictionary.Key($v_key) = $v_newKey<br />
EndFunc ;==>_ChangeKey<br />
<br />
; Removes a key, item pair from a Dictionary object.<br />
Func _ItemRemove($oDictionary, $v_key)<br />
$oDictionary.Remove($v_key)<br />
If @error Then Return SetError(1, 1, -1)<br />
EndFunc ;==>_ItemRemove<br />
<br />
; Returns the number of items in a collection or Dictionary object.<br />
Func _ItemCount($oDictionary)<br />
Return $oDictionary.Count<br />
EndFunc ;==>_ItemCount<br />
<br />
; Returns an array containing all the items in a Dictionary object<br />
Func _GetItems($oDictionary)<br />
Return $oDictionary.Items<br />
EndFunc ;==>_GetItems<br />
<br />
Func _Clear($oDictionary)<br />
Return $oDictionary.RemoveAll<br />
EndFunc<br />
<br />
</syntaxhighlight><br />
<br /><br />
<br /><br />
Below are several examples that illustrate the usage of the Scripting Dictionary UDF in AutoIt.<br />
<br /><br />
Example 1:<br />
<syntaxhighlight lang='autoit'><br />
; Author Jefrey<br />
; Forum https://www.autoitscript.com/forum/profile/75137-jefrey/<br />
#include 'scriptingdic.au3'<br />
#include <Array.au3> ; Needed only for _ArrayDisplay, and not required by the lib<br />
<br />
; Init the object<br />
$oObj = _InitDictionary()<br />
<br />
; Adding a single value<br />
_AddItem($oObj, 0, "Test")<br />
; And showing it<br />
msgbox(0, '', _Item($oObj, 0))<br />
<br />
; Adding an array<br />
Dim $aArr[] = [0, -80, -49, -44, 80, 100, 8, 7, 6, 5, 4, 3, 2, 1]<br />
_AddItem($oObj, 1, $aArr)<br />
; And showing it<br />
_ArrayDisplay(_Item($oObj, 1))<br />
<br />
; We can also use this approach:<br />
$oObj3 = _InitDictionary()<br />
$oObj.Add("test", "foo")<br />
MsgBox(0, '', $oObj.Item("test"))<br />
</syntaxhighlight><br />
Example 2 is a reply to a common question asked on the Forum, How to find duplicate lines/values... <br />
<syntaxhighlight lang='autoit'><br />
; Author Malkey <br />
; https://www.autoitscript.com/forum/profile/31256-malkey/<br />
; Forum https://www.autoitscript.com/forum/topic/116156-best-way-to-compare-strings-for-duplicates/?do=findComment&comment=810752<br />
Local $sStr, $begin, $dif, $sMatches<br />
<br />
; Create random test data<br />
For $i = 1 To 1000<br />
$sStr &= Chr(Random(Asc("a"), Asc("z"), 1)) & Chr(Random(Asc("a"), Asc("z"), 1)) & _<br />
Chr(Random(Asc("a"), Asc("z"), 1)) & Chr(Random(Asc("a"), Asc("z"), 1)) & @CRLF ;<br />
Next<br />
;ConsoleWrite($sStr & @CRLF)<br />
<br />
$begin = TimerInit()<br />
<br />
Local $oDict = ObjCreate("Scripting.Dictionary") ; to create a dictionary object<br />
Local $aArray = StringSplit(StringStripWS($sStr, 2), @CRLF, 3)<br />
For $i = 0 To UBound($aArray) - 1<br />
If $oDict.Exists($aArray[$i]) Then<br />
$sMatches &= $i & " " & $aArray[$i] & @CRLF ; Record duplicates<br />
Else<br />
$oDict.add($aArray[$i], '') ; to store a string (you may set $value = '' if you have no use of it)<br />
EndIf<br />
Next<br />
$dif = Round(TimerDiff($begin) / 1000, 3) & " secs"<br />
<br />
;Display results<br />
If $sMatches <> "" Then<br />
MsgBox(0, "Results", StringTrimRight($sMatches, 2) & @CRLF & "Time taken = " & $dif)<br />
Else<br />
MsgBox(0, "Results", "No duplicates found" & @CRLF & "Time taken = " & $dif)<br />
EndIf<br />
</syntaxhighlight><br />
<br /><br />
<br /><br /><br />
_____________________________________________________<br />
<br /><br />
<br />
The next example does not use the scripting dictionary UDF, but makes use of Global Enumerators. This allows access to data through named elements.<br />
<syntaxhighlight lang='autoit'><br />
; Author guinness<br />
; Forum https://www.autoitscript.com/forum/topic/173803-oop-like-approach-in-autoit/<br />
#include <MsgBoxConstants.au3><br />
<br />
; ---- Start of Person Class<br />
<br />
; Stored in the 'object' to verify it's our 'object' and not some random array<br />
Global Const $PERSON_GUID = '4197B285-6AB1-489B-8585-08C852E33F3D'<br />
<br />
; Friendly names for 0, 1, 2 and 3<br />
Global Enum $PERSON_AGE, $PERSON_NAME, $PERSON_ID, $PERSON_MAX<br />
<br />
; Constructor<br />
Func Person($sName, $iAge)<br />
Local $hPerson[$PERSON_MAX]<br />
<br />
; Set the GUID, so as the verification will work<br />
$hPerson[$PERSON_ID] = $PERSON_GUID<br />
<br />
Person_SetAge($hPerson, $iAge)<br />
Person_SetName($hPerson, $sName)<br />
<br />
; Return the Person 'object'<br />
Return $hPerson<br />
EndFunc ;==>Person<br />
<br />
; Getter for the age property<br />
Func Person_GetAge(ByRef $hPerson)<br />
Return _Person_IsObject($hPerson) ? $hPerson[$PERSON_AGE] : Null<br />
EndFunc ;==>Person_GetAge<br />
<br />
; Setter for the age property<br />
Func Person_SetAge(ByRef $hPerson, $iAge)<br />
; If not a valid 'object' or integer then return<br />
If Not _Person_IsObject($hPerson) Or Not IsInt($iAge) Then Return<br />
<br />
; Set the age<br />
$hPerson[$PERSON_AGE] = $iAge<br />
EndFunc ;==>Person_SetAge<br />
<br />
; Getter for the name property<br />
Func Person_GetName(ByRef $hPerson)<br />
Return _Person_IsObject($hPerson) ? $hPerson[$PERSON_NAME] : Null<br />
EndFunc ;==>Person_GetName<br />
<br />
; Setter for the name property<br />
Func Person_SetName(ByRef $hPerson, $sName)<br />
; If not a valid 'object' then return<br />
If Not _Person_IsObject($hPerson) Then Return<br />
<br />
; Set the name<br />
$hPerson[$PERSON_NAME] = $sName<br />
EndFunc ;==>Person_SetName<br />
<br />
; ToString() for the 'object'<br />
Func Person_ToString(ByRef $hPerson)<br />
Return _Person_IsObject($hPerson) ? StringFormat('Name: %s, Age: %i', $hPerson[$PERSON_NAME], $hPerson[$PERSON_AGE]) : Null<br />
EndFunc ;==>Person_ToString<br />
<br />
; Check if it's a valid 'object' and not some random array. "NTERNAL ONLY!<br />
Func _Person_IsObject(ByRef $hPerson)<br />
Return UBound($hPerson) = $PERSON_MAX And $hPerson[$PERSON_ID] == $PERSON_GUID<br />
EndFunc ;==>_Person_IsObject<br />
<br />
; ---- End of Person Class<br />
<br />
Example()<br />
<br />
Func Example()<br />
; Store the Person 'object', which is just a glorified array<br />
Local $hP1 = Person('John', 30)<br />
<br />
; Display the 'object'<br />
MsgBox($MB_SYSTEMMODAL, 'Person 1', Person_ToString($hP1))<br />
<br />
; Create a new person<br />
<br />
; Store the Person 'object', which is just a glorified array<br />
Local $hP2 = Person('James', 36)<br />
<br />
; Display the 'object'<br />
MsgBox($MB_SYSTEMMODAL, 'Person 2', Person_ToString($hP2))<br />
<br />
; Set the age for Person 2<br />
Person_SetAge($hP2, 45)<br />
<br />
; Display the 'object'<br />
MsgBox($MB_SYSTEMMODAL, 'Person 2 - Revised', Person_ToString($hP2))<br />
EndFunc ;==>Example<br />
</syntaxhighlight><br />
Please see the current beta for more information on map functions.<br />
<syntaxhighlight lang='autoit'><br />
</syntaxhighlight></div>Skysnakehttps://www.autoitscript.com/w/index.php?title=Associative_Arrays&diff=13726Associative Arrays2017-11-30T10:13:31Z<p>Skysnake: </p>
<hr />
<div>In computer science, an associative array, map, symbol table, or dictionary is an abstract data type composed of a collection of (key, value) pairs, such that each possible key appears at most once in the collection.<br />
An associative array differs from a “normal” array in one major way: rather than being indexed numerically (i.e. 0, 1, 2, 3, …), it is indexed by a key, or a language-like word. <br />
A '''Scripting.Dictionary''' is a standard object provided by the '''Microsoft Scripting Runtime''' (scrrun.dll) dependency and is commonly used in VBScript, a reference to which needs to be added in order to create an object in your AutoIt project.<br />
<br /><br />
<br /><br />
This discussion by '''Nutster''' explains the [https://www.autoitscript.com/forum/topic/59174-associative-array-functions/#comment-445963 original implementation] of Associative Arrays in AutoIt. <br />
An associative array is an array where the keys (index numbers) are string instead of integer, as they are in AutoIt. Linux / Unix awk and perl use associative arrays by default. The following functions can be used to manage a version of associative arrays in single AutoIt variables. A hash table is used to store the values because it is faster to insert than other options I can think of and pretty much as fast as them to retrieve the data. The memory requirements are a little higher than other methods, but I think it is a reasonable trade-off. It uses a simple hash function that can probably be easily improved upon and while it can resize the hash table, the resize is slow so try to make your initial size large enough for all your elements. Please see the Include file and an exerciser that demonstrates how to use the associative array functions. Read the comments at the top of each function for more details on their use.<br />
<br /><br />
<br /><br />
A few notes on Associative Arrays:<br /><br />
* Think of an associative array as an array with named elements<br />
* Comparisons can be exact (binary) or case insensitive (alpha)<br />
<br /><br /><br />
At the time of writing this - 28 November 2017 - a new '''map data type''' is under development for AutoIt. It is availabe in the current [https://www.autoitscript.com/forum/topic/163657-maps-beta/?do=findComment&comment=1296278 beta release].<br />
<br /><br />
<br /><br />
Please also see this entry in the Snippets section of this Wiki [https://www.autoitscript.com/wiki/Snippets_(_AutoIt_Array_)#AssocArray _AssocArray] <br />
<br /><br />
<br /><br />
<br />
A dictionary object example by [https://www.autoitscript.com/forum/profile/2709-mhz/ MHz]<br />
<syntaxhighlight lang='autoit'><br />
; Author Mhz<br />
; Forum https://www.autoitscript.com/forum/topic/182334-scripting-dictionary-modified/<br />
Global $vKey, $sItem, $sMsg, $oDictionary <br />
<br />
; Create dictionary object<br />
$oDictionary = ObjCreate("Scripting.Dictionary")<br />
<br />
If @error Then<br />
MsgBox(0, '', 'Error creating the dictionary object')<br />
Else<br />
; Add keys with items<br />
$oDictionary.Add ("One", "Same" )<br />
$oDictionary.Add ("Two", "Car" )<br />
$oDictionary.Add ("Three", "House" )<br />
$oDictionary.Add ("Four", "Boat" )<br />
<br />
If $oDictionary.Exists('One') Then<br />
; Display item<br />
MsgBox(0x0, 'Item One', $oDictionary.Item('One'), 2)<br />
; Set an item<br />
$oDictionary.Item('One') = 'Changed'<br />
; Display item<br />
MsgBox(0x20, 'Did Item One Change?', $oDictionary.Item('One'), 3)<br />
; Remove key<br />
$oDictionary.Remove('One')<br />
; <br />
$oDictionary.Key ('Two') = 'Bike'<br />
EndIf<br />
<br />
Sleep(1000)<br />
<br />
; Store items into a variable<br />
For $vKey In $oDictionary<br />
$sItem &= $oDictionary.Item($vKey) & @CRLF<br />
Next<br />
<br />
; Display items<br />
MsgBox(0x0, 'Items Count: ' & $oDictionary.Count, $sItem, 3)<br />
<br />
; Add items into an array<br />
$aItems = $oDictionary.Items<br />
<br />
; Display items in the array<br />
For $i = 0 To $oDictionary.Count -1<br />
MsgBox(0x0, 'Items [ ' & $i & ' ]', $aItems[$i], 2)<br />
Next<br />
<br />
Sleep(1000)<br />
<br />
; Add keys into an array<br />
$aKeys = $oDictionary.Keys<br />
<br />
; Display keys in the array<br />
For $i = 0 To $oDictionary.Count -1<br />
MsgBox(0x0, 'Keys [ ' & $i & ' ]', $aKeys[$i], 2)<br />
Next<br />
EndIf<br />
</syntaxhighlight><br />
<br /><br />
<br /><br />
The original AutoIt Scripting Dictionary implementation appears to have been by Gary Frost as far back as 2007. It has since been modified to the following:<br />
<br /><br />
<syntaxhighlight lang='autoit'><br />
#cs<br />
Scripting Dictionary UDF<br />
<br />
Made by GaryFrost <https://www.autoitscript.com/forum/topic/47048-scripting-dictionary/><br />
Modified by Jefrey <jefrey[at]jefrey.ml><br />
<br />
Forum https://www.autoitscript.com/forum/topic/182334-scripting-dictionary-modified/<br />
<br />
#ce<br />
<br />
Func _InitDictionary()<br />
Return ObjCreate("Scripting.Dictionary")<br />
EndFunc ;==>_InitDictionary<br />
<br />
; Adds a key and item pair to a Dictionary object.<br />
Func _AddItem($oDictionary, $v_key, $v_item)<br />
$oDictionary.ADD($v_key, $v_item)<br />
If @error Then Return SetError(1, 1, -1)<br />
EndFunc ;==>_AddItem<br />
<br />
; Returns true if a specified key exists in the Dictionary object, false if it does not.<br />
Func _ItemExists($oDictionary, $v_key)<br />
Return $oDictionary.Exists($v_key)<br />
EndFunc ;==>_ItemExists<br />
<br />
; Returns an item for a specified key in a Dictionary object<br />
Func _Item($oDictionary, $v_key)<br />
Return $oDictionary.Item($v_key)<br />
EndFunc ;==>_Item<br />
<br />
; Sets an item for a specified key in a Dictionary object<br />
Func _ChangeItem($oDictionary, $v_key, $v_item)<br />
$oDictionary.Item($v_key) = $v_item<br />
EndFunc ;==>_ChangeItem<br />
<br />
; Sets a key in a Dictionary object.<br />
Func _ChangeKey($oDictionary, $v_key, $v_newKey)<br />
$oDictionary.Key($v_key) = $v_newKey<br />
EndFunc ;==>_ChangeKey<br />
<br />
; Removes a key, item pair from a Dictionary object.<br />
Func _ItemRemove($oDictionary, $v_key)<br />
$oDictionary.Remove($v_key)<br />
If @error Then Return SetError(1, 1, -1)<br />
EndFunc ;==>_ItemRemove<br />
<br />
; Returns the number of items in a collection or Dictionary object.<br />
Func _ItemCount($oDictionary)<br />
Return $oDictionary.Count<br />
EndFunc ;==>_ItemCount<br />
<br />
; Returns an array containing all the items in a Dictionary object<br />
Func _GetItems($oDictionary)<br />
Return $oDictionary.Items<br />
EndFunc ;==>_GetItems<br />
<br />
Func _Clear($oDictionary)<br />
Return $oDictionary.RemoveAll<br />
EndFunc<br />
<br />
</syntaxhighlight><br />
<br /><br />
<br /><br />
Below are several examples that illustrate the usage of the Scripting Dictionary UDF in AutoIt.<br />
<br /><br />
Example 1:<br />
<syntaxhighlight lang='autoit'><br />
; Author Jefrey<br />
; Forum https://www.autoitscript.com/forum/profile/75137-jefrey/<br />
#include 'scriptingdic.au3'<br />
#include <Array.au3> ; Needed only for _ArrayDisplay, and not required by the lib<br />
<br />
; Init the object<br />
$oObj = _InitDictionary()<br />
<br />
; Adding a single value<br />
_AddItem($oObj, 0, "Test")<br />
; And showing it<br />
msgbox(0, '', _Item($oObj, 0))<br />
<br />
; Adding an array<br />
Dim $aArr[] = [0, -80, -49, -44, 80, 100, 8, 7, 6, 5, 4, 3, 2, 1]<br />
_AddItem($oObj, 1, $aArr)<br />
; And showing it<br />
_ArrayDisplay(_Item($oObj, 1))<br />
<br />
; We can also use this approach:<br />
$oObj3 = _InitDictionary()<br />
$oObj.Add("test", "foo")<br />
MsgBox(0, '', $oObj.Item("test"))<br />
</syntaxhighlight><br />
Example 2 is a reply to a common question asked on the Forum, How to find duplicate lines/values... <br />
<syntaxhighlight lang='autoit'><br />
; Author Malkey <br />
; https://www.autoitscript.com/forum/profile/31256-malkey/<br />
; Forum https://www.autoitscript.com/forum/topic/116156-best-way-to-compare-strings-for-duplicates/?do=findComment&comment=810752<br />
Local $sStr, $begin, $dif, $sMatches<br />
<br />
; Create random test data<br />
For $i = 1 To 1000<br />
$sStr &= Chr(Random(Asc("a"), Asc("z"), 1)) & Chr(Random(Asc("a"), Asc("z"), 1)) & _<br />
Chr(Random(Asc("a"), Asc("z"), 1)) & Chr(Random(Asc("a"), Asc("z"), 1)) & @CRLF ;<br />
Next<br />
;ConsoleWrite($sStr & @CRLF)<br />
<br />
$begin = TimerInit()<br />
<br />
Local $oDict = ObjCreate("Scripting.Dictionary") ; to create a dictionary object<br />
Local $aArray = StringSplit(StringStripWS($sStr, 2), @CRLF, 3)<br />
For $i = 0 To UBound($aArray) - 1<br />
If $oDict.Exists($aArray[$i]) Then<br />
$sMatches &= $i & " " & $aArray[$i] & @CRLF ; Record duplicates<br />
Else<br />
$oDict.add($aArray[$i], '') ; to store a string (you may set $value = '' if you have no use of it)<br />
EndIf<br />
Next<br />
$dif = Round(TimerDiff($begin) / 1000, 3) & " secs"<br />
<br />
;Display results<br />
If $sMatches <> "" Then<br />
MsgBox(0, "Results", StringTrimRight($sMatches, 2) & @CRLF & "Time taken = " & $dif)<br />
Else<br />
MsgBox(0, "Results", "No duplicates found" & @CRLF & "Time taken = " & $dif)<br />
EndIf<br />
</syntaxhighlight><br />
<br /><br />
<br /><br /><br />
_____________________________________________________<br />
<br /><br />
<br />
The next example does not use the scripting dictionary UDF, but makes use of Global Enumerators. This allows access to data through named elements.<br />
<syntaxhighlight lang='autoit'><br />
; Author guinness<br />
; Forum https://www.autoitscript.com/forum/topic/173803-oop-like-approach-in-autoit/<br />
#include <MsgBoxConstants.au3><br />
<br />
; ---- Start of Person Class<br />
<br />
; Stored in the 'object' to verify it's our 'object' and not some random array<br />
Global Const $PERSON_GUID = '4197B285-6AB1-489B-8585-08C852E33F3D'<br />
<br />
; Friendly names for 0, 1, 2 and 3<br />
Global Enum $PERSON_AGE, $PERSON_NAME, $PERSON_ID, $PERSON_MAX<br />
<br />
; Constructor<br />
Func Person($sName, $iAge)<br />
Local $hPerson[$PERSON_MAX]<br />
<br />
; Set the GUID, so as the verification will work<br />
$hPerson[$PERSON_ID] = $PERSON_GUID<br />
<br />
Person_SetAge($hPerson, $iAge)<br />
Person_SetName($hPerson, $sName)<br />
<br />
; Return the Person 'object'<br />
Return $hPerson<br />
EndFunc ;==>Person<br />
<br />
; Getter for the age property<br />
Func Person_GetAge(ByRef $hPerson)<br />
Return _Person_IsObject($hPerson) ? $hPerson[$PERSON_AGE] : Null<br />
EndFunc ;==>Person_GetAge<br />
<br />
; Setter for the age property<br />
Func Person_SetAge(ByRef $hPerson, $iAge)<br />
; If not a valid 'object' or integer then return<br />
If Not _Person_IsObject($hPerson) Or Not IsInt($iAge) Then Return<br />
<br />
; Set the age<br />
$hPerson[$PERSON_AGE] = $iAge<br />
EndFunc ;==>Person_SetAge<br />
<br />
; Getter for the name property<br />
Func Person_GetName(ByRef $hPerson)<br />
Return _Person_IsObject($hPerson) ? $hPerson[$PERSON_NAME] : Null<br />
EndFunc ;==>Person_GetName<br />
<br />
; Setter for the name property<br />
Func Person_SetName(ByRef $hPerson, $sName)<br />
; If not a valid 'object' then return<br />
If Not _Person_IsObject($hPerson) Then Return<br />
<br />
; Set the name<br />
$hPerson[$PERSON_NAME] = $sName<br />
EndFunc ;==>Person_SetName<br />
<br />
; ToString() for the 'object'<br />
Func Person_ToString(ByRef $hPerson)<br />
Return _Person_IsObject($hPerson) ? StringFormat('Name: %s, Age: %i', $hPerson[$PERSON_NAME], $hPerson[$PERSON_AGE]) : Null<br />
EndFunc ;==>Person_ToString<br />
<br />
; Check if it's a valid 'object' and not some random array. "NTERNAL ONLY!<br />
Func _Person_IsObject(ByRef $hPerson)<br />
Return UBound($hPerson) = $PERSON_MAX And $hPerson[$PERSON_ID] == $PERSON_GUID<br />
EndFunc ;==>_Person_IsObject<br />
<br />
; ---- End of Person Class<br />
<br />
Example()<br />
<br />
Func Example()<br />
; Store the Person 'object', which is just a glorified array<br />
Local $hP1 = Person('John', 30)<br />
<br />
; Display the 'object'<br />
MsgBox($MB_SYSTEMMODAL, 'Person 1', Person_ToString($hP1))<br />
<br />
; Create a new person<br />
<br />
; Store the Person 'object', which is just a glorified array<br />
Local $hP2 = Person('James', 36)<br />
<br />
; Display the 'object'<br />
MsgBox($MB_SYSTEMMODAL, 'Person 2', Person_ToString($hP2))<br />
<br />
; Set the age for Person 2<br />
Person_SetAge($hP2, 45)<br />
<br />
; Display the 'object'<br />
MsgBox($MB_SYSTEMMODAL, 'Person 2 - Revised', Person_ToString($hP2))<br />
EndFunc ;==>Example<br />
</syntaxhighlight><br />
Please see the current beta for more information on map functions.<br />
<syntaxhighlight lang='autoit'><br />
</syntaxhighlight></div>Skysnakehttps://www.autoitscript.com/w/index.php?title=Associative_Arrays&diff=13725Associative Arrays2017-11-30T10:12:51Z<p>Skysnake: </p>
<hr />
<div>In computer science, an associative array, map, symbol table, or dictionary is an abstract data type composed of a collection of (key, value) pairs, such that each possible key appears at most once in the collection.<br />
An associative array differs from a “normal” array in one major way: rather than being indexed numerically (i.e. 0, 1, 2, 3, …), it is indexed by a key, or a language-like word. <br />
A '''Scripting.Dictionary''' is a standard object provided by the '''Microsoft Scripting Runtime''' (scrrun.dll) dependency and is commonly used in VBScript, a reference to which needs to be added in order to create an object in your AutoIt project.<br />
<br /><br />
<br /><br />
This discussion explains the [https://www.autoitscript.com/forum/topic/59174-associative-array-functions/#comment-445963 original implementation] of Associative Arrays in AutoIt. <br />
An associative array is an array where the keys (index numbers) are string instead of integer, as they are in AutoIt. Linux / Unix awk and perl use associative arrays by default. The following functions can be used to manage a version of associative arrays in single AutoIt variables. A hash table is used to store the values because it is faster to insert than other options I can think of and pretty much as fast as them to retrieve the data. The memory requirements are a little higher than other methods, but I think it is a reasonable trade-off. It uses a simple hash function that can probably be easily improved upon and while it can resize the hash table, the resize is slow so try to make your initial size large enough for all your elements. Please see the Include file and an exerciser that demonstrates how to use the associative array functions. Read the comments at the top of each function for more details on their use.<br />
<br /><br />
<br /><br />
A few notes on Associative Arrays:<br /><br />
* Think of an associative array as an array with named elements<br />
* Comparisons can be exact (binary) or case insensitive (alpha)<br />
<br /><br /><br />
At the time of writing this - 28 November 2017 - a new '''map data type''' is under development for AutoIt. It is availabe in the current [https://www.autoitscript.com/forum/topic/163657-maps-beta/?do=findComment&comment=1296278 beta release].<br />
<br /><br />
<br /><br />
Please also see this entry in the Snippets section of this Wiki [https://www.autoitscript.com/wiki/Snippets_(_AutoIt_Array_)#AssocArray _AssocArray] <br />
<br /><br />
<br /><br />
<br />
A dictionary object example by [https://www.autoitscript.com/forum/profile/2709-mhz/ MHz]<br />
<syntaxhighlight lang='autoit'><br />
; Author Mhz<br />
; Forum https://www.autoitscript.com/forum/topic/182334-scripting-dictionary-modified/<br />
Global $vKey, $sItem, $sMsg, $oDictionary <br />
<br />
; Create dictionary object<br />
$oDictionary = ObjCreate("Scripting.Dictionary")<br />
<br />
If @error Then<br />
MsgBox(0, '', 'Error creating the dictionary object')<br />
Else<br />
; Add keys with items<br />
$oDictionary.Add ("One", "Same" )<br />
$oDictionary.Add ("Two", "Car" )<br />
$oDictionary.Add ("Three", "House" )<br />
$oDictionary.Add ("Four", "Boat" )<br />
<br />
If $oDictionary.Exists('One') Then<br />
; Display item<br />
MsgBox(0x0, 'Item One', $oDictionary.Item('One'), 2)<br />
; Set an item<br />
$oDictionary.Item('One') = 'Changed'<br />
; Display item<br />
MsgBox(0x20, 'Did Item One Change?', $oDictionary.Item('One'), 3)<br />
; Remove key<br />
$oDictionary.Remove('One')<br />
; <br />
$oDictionary.Key ('Two') = 'Bike'<br />
EndIf<br />
<br />
Sleep(1000)<br />
<br />
; Store items into a variable<br />
For $vKey In $oDictionary<br />
$sItem &= $oDictionary.Item($vKey) & @CRLF<br />
Next<br />
<br />
; Display items<br />
MsgBox(0x0, 'Items Count: ' & $oDictionary.Count, $sItem, 3)<br />
<br />
; Add items into an array<br />
$aItems = $oDictionary.Items<br />
<br />
; Display items in the array<br />
For $i = 0 To $oDictionary.Count -1<br />
MsgBox(0x0, 'Items [ ' & $i & ' ]', $aItems[$i], 2)<br />
Next<br />
<br />
Sleep(1000)<br />
<br />
; Add keys into an array<br />
$aKeys = $oDictionary.Keys<br />
<br />
; Display keys in the array<br />
For $i = 0 To $oDictionary.Count -1<br />
MsgBox(0x0, 'Keys [ ' & $i & ' ]', $aKeys[$i], 2)<br />
Next<br />
EndIf<br />
</syntaxhighlight><br />
<br /><br />
<br /><br />
The original AutoIt Scripting Dictionary implementation appears to have been by Gary Frost as far back as 2007. It has since been modified to the following:<br />
<br /><br />
<syntaxhighlight lang='autoit'><br />
#cs<br />
Scripting Dictionary UDF<br />
<br />
Made by GaryFrost <https://www.autoitscript.com/forum/topic/47048-scripting-dictionary/><br />
Modified by Jefrey <jefrey[at]jefrey.ml><br />
<br />
Forum https://www.autoitscript.com/forum/topic/182334-scripting-dictionary-modified/<br />
<br />
#ce<br />
<br />
Func _InitDictionary()<br />
Return ObjCreate("Scripting.Dictionary")<br />
EndFunc ;==>_InitDictionary<br />
<br />
; Adds a key and item pair to a Dictionary object.<br />
Func _AddItem($oDictionary, $v_key, $v_item)<br />
$oDictionary.ADD($v_key, $v_item)<br />
If @error Then Return SetError(1, 1, -1)<br />
EndFunc ;==>_AddItem<br />
<br />
; Returns true if a specified key exists in the Dictionary object, false if it does not.<br />
Func _ItemExists($oDictionary, $v_key)<br />
Return $oDictionary.Exists($v_key)<br />
EndFunc ;==>_ItemExists<br />
<br />
; Returns an item for a specified key in a Dictionary object<br />
Func _Item($oDictionary, $v_key)<br />
Return $oDictionary.Item($v_key)<br />
EndFunc ;==>_Item<br />
<br />
; Sets an item for a specified key in a Dictionary object<br />
Func _ChangeItem($oDictionary, $v_key, $v_item)<br />
$oDictionary.Item($v_key) = $v_item<br />
EndFunc ;==>_ChangeItem<br />
<br />
; Sets a key in a Dictionary object.<br />
Func _ChangeKey($oDictionary, $v_key, $v_newKey)<br />
$oDictionary.Key($v_key) = $v_newKey<br />
EndFunc ;==>_ChangeKey<br />
<br />
; Removes a key, item pair from a Dictionary object.<br />
Func _ItemRemove($oDictionary, $v_key)<br />
$oDictionary.Remove($v_key)<br />
If @error Then Return SetError(1, 1, -1)<br />
EndFunc ;==>_ItemRemove<br />
<br />
; Returns the number of items in a collection or Dictionary object.<br />
Func _ItemCount($oDictionary)<br />
Return $oDictionary.Count<br />
EndFunc ;==>_ItemCount<br />
<br />
; Returns an array containing all the items in a Dictionary object<br />
Func _GetItems($oDictionary)<br />
Return $oDictionary.Items<br />
EndFunc ;==>_GetItems<br />
<br />
Func _Clear($oDictionary)<br />
Return $oDictionary.RemoveAll<br />
EndFunc<br />
<br />
</syntaxhighlight><br />
<br /><br />
<br /><br />
Below are several examples that illustrate the usage of the Scripting Dictionary UDF in AutoIt.<br />
<br /><br />
Example 1:<br />
<syntaxhighlight lang='autoit'><br />
; Author Jefrey<br />
; Forum https://www.autoitscript.com/forum/profile/75137-jefrey/<br />
#include 'scriptingdic.au3'<br />
#include <Array.au3> ; Needed only for _ArrayDisplay, and not required by the lib<br />
<br />
; Init the object<br />
$oObj = _InitDictionary()<br />
<br />
; Adding a single value<br />
_AddItem($oObj, 0, "Test")<br />
; And showing it<br />
msgbox(0, '', _Item($oObj, 0))<br />
<br />
; Adding an array<br />
Dim $aArr[] = [0, -80, -49, -44, 80, 100, 8, 7, 6, 5, 4, 3, 2, 1]<br />
_AddItem($oObj, 1, $aArr)<br />
; And showing it<br />
_ArrayDisplay(_Item($oObj, 1))<br />
<br />
; We can also use this approach:<br />
$oObj3 = _InitDictionary()<br />
$oObj.Add("test", "foo")<br />
MsgBox(0, '', $oObj.Item("test"))<br />
</syntaxhighlight><br />
Example 2 is a reply to a common question asked on the Forum, How to find duplicate lines/values... <br />
<syntaxhighlight lang='autoit'><br />
; Author Malkey <br />
; https://www.autoitscript.com/forum/profile/31256-malkey/<br />
; Forum https://www.autoitscript.com/forum/topic/116156-best-way-to-compare-strings-for-duplicates/?do=findComment&comment=810752<br />
Local $sStr, $begin, $dif, $sMatches<br />
<br />
; Create random test data<br />
For $i = 1 To 1000<br />
$sStr &= Chr(Random(Asc("a"), Asc("z"), 1)) & Chr(Random(Asc("a"), Asc("z"), 1)) & _<br />
Chr(Random(Asc("a"), Asc("z"), 1)) & Chr(Random(Asc("a"), Asc("z"), 1)) & @CRLF ;<br />
Next<br />
;ConsoleWrite($sStr & @CRLF)<br />
<br />
$begin = TimerInit()<br />
<br />
Local $oDict = ObjCreate("Scripting.Dictionary") ; to create a dictionary object<br />
Local $aArray = StringSplit(StringStripWS($sStr, 2), @CRLF, 3)<br />
For $i = 0 To UBound($aArray) - 1<br />
If $oDict.Exists($aArray[$i]) Then<br />
$sMatches &= $i & " " & $aArray[$i] & @CRLF ; Record duplicates<br />
Else<br />
$oDict.add($aArray[$i], '') ; to store a string (you may set $value = '' if you have no use of it)<br />
EndIf<br />
Next<br />
$dif = Round(TimerDiff($begin) / 1000, 3) & " secs"<br />
<br />
;Display results<br />
If $sMatches <> "" Then<br />
MsgBox(0, "Results", StringTrimRight($sMatches, 2) & @CRLF & "Time taken = " & $dif)<br />
Else<br />
MsgBox(0, "Results", "No duplicates found" & @CRLF & "Time taken = " & $dif)<br />
EndIf<br />
</syntaxhighlight><br />
<br /><br />
<br /><br /><br />
_____________________________________________________<br />
<br /><br />
<br />
The next example does not use the scripting dictionary UDF, but makes use of Global Enumerators. This allows access to data through named elements.<br />
<syntaxhighlight lang='autoit'><br />
; Author guinness<br />
; Forum https://www.autoitscript.com/forum/topic/173803-oop-like-approach-in-autoit/<br />
#include <MsgBoxConstants.au3><br />
<br />
; ---- Start of Person Class<br />
<br />
; Stored in the 'object' to verify it's our 'object' and not some random array<br />
Global Const $PERSON_GUID = '4197B285-6AB1-489B-8585-08C852E33F3D'<br />
<br />
; Friendly names for 0, 1, 2 and 3<br />
Global Enum $PERSON_AGE, $PERSON_NAME, $PERSON_ID, $PERSON_MAX<br />
<br />
; Constructor<br />
Func Person($sName, $iAge)<br />
Local $hPerson[$PERSON_MAX]<br />
<br />
; Set the GUID, so as the verification will work<br />
$hPerson[$PERSON_ID] = $PERSON_GUID<br />
<br />
Person_SetAge($hPerson, $iAge)<br />
Person_SetName($hPerson, $sName)<br />
<br />
; Return the Person 'object'<br />
Return $hPerson<br />
EndFunc ;==>Person<br />
<br />
; Getter for the age property<br />
Func Person_GetAge(ByRef $hPerson)<br />
Return _Person_IsObject($hPerson) ? $hPerson[$PERSON_AGE] : Null<br />
EndFunc ;==>Person_GetAge<br />
<br />
; Setter for the age property<br />
Func Person_SetAge(ByRef $hPerson, $iAge)<br />
; If not a valid 'object' or integer then return<br />
If Not _Person_IsObject($hPerson) Or Not IsInt($iAge) Then Return<br />
<br />
; Set the age<br />
$hPerson[$PERSON_AGE] = $iAge<br />
EndFunc ;==>Person_SetAge<br />
<br />
; Getter for the name property<br />
Func Person_GetName(ByRef $hPerson)<br />
Return _Person_IsObject($hPerson) ? $hPerson[$PERSON_NAME] : Null<br />
EndFunc ;==>Person_GetName<br />
<br />
; Setter for the name property<br />
Func Person_SetName(ByRef $hPerson, $sName)<br />
; If not a valid 'object' then return<br />
If Not _Person_IsObject($hPerson) Then Return<br />
<br />
; Set the name<br />
$hPerson[$PERSON_NAME] = $sName<br />
EndFunc ;==>Person_SetName<br />
<br />
; ToString() for the 'object'<br />
Func Person_ToString(ByRef $hPerson)<br />
Return _Person_IsObject($hPerson) ? StringFormat('Name: %s, Age: %i', $hPerson[$PERSON_NAME], $hPerson[$PERSON_AGE]) : Null<br />
EndFunc ;==>Person_ToString<br />
<br />
; Check if it's a valid 'object' and not some random array. "NTERNAL ONLY!<br />
Func _Person_IsObject(ByRef $hPerson)<br />
Return UBound($hPerson) = $PERSON_MAX And $hPerson[$PERSON_ID] == $PERSON_GUID<br />
EndFunc ;==>_Person_IsObject<br />
<br />
; ---- End of Person Class<br />
<br />
Example()<br />
<br />
Func Example()<br />
; Store the Person 'object', which is just a glorified array<br />
Local $hP1 = Person('John', 30)<br />
<br />
; Display the 'object'<br />
MsgBox($MB_SYSTEMMODAL, 'Person 1', Person_ToString($hP1))<br />
<br />
; Create a new person<br />
<br />
; Store the Person 'object', which is just a glorified array<br />
Local $hP2 = Person('James', 36)<br />
<br />
; Display the 'object'<br />
MsgBox($MB_SYSTEMMODAL, 'Person 2', Person_ToString($hP2))<br />
<br />
; Set the age for Person 2<br />
Person_SetAge($hP2, 45)<br />
<br />
; Display the 'object'<br />
MsgBox($MB_SYSTEMMODAL, 'Person 2 - Revised', Person_ToString($hP2))<br />
EndFunc ;==>Example<br />
</syntaxhighlight><br />
Please see the current beta for more information on map functions.<br />
<syntaxhighlight lang='autoit'><br />
</syntaxhighlight></div>Skysnakehttps://www.autoitscript.com/w/index.php?title=Associative_Arrays&diff=13724Associative Arrays2017-11-30T10:11:31Z<p>Skysnake: </p>
<hr />
<div>In computer science, an associative array, map, symbol table, or dictionary is an abstract data type composed of a collection of (key, value) pairs, such that each possible key appears at most once in the collection.<br />
An associative array differs from a “normal” array in one major way: rather than being indexed numerically (i.e. 0, 1, 2, 3, …), it is indexed by a key, or a language-like word. <br />
A '''Scripting.Dictionary''' is a standard object provided by the '''Microsoft Scripting Runtime''' (scrrun.dll) dependency and is commonly used in VBScript, a reference to which needs to be added in order to create an object in your AutoIt project.<br />
<br /><br />
<br /><br />
This discussion explains the [https://www.autoitscript.com/forum/topic/59174-associative-array-functions/#comment-445963 original implementation] of Associative Arrays in AutoIt. <br />
An associative array is an array where the keys (index numbers) are string instead of integer, as they are in AutoIt. Linux / Unix awk and perl use associative arrays by default. The following functions can be used to manage a version of associative arrays in single AutoIt variables.<br />
<br />
A hash table is used to store the values because it is faster to insert than other options I can think of and pretty much as fast as them to retrieve the data. The memory requirements are a little higher than other methods, but I think it is a reasonable trade-off. It uses a simple hash function that can probably be easily improved upon and while it can resize the hash table, the resize is slow so try to make your initial size large enough for all your elements.<br />
<br />
Attached please find an Include file and an exerciser that demonstrates how to use my associative array functions. Read the comments at the top of each function for more details on their use.<br />
<br /><br />
<br /><br />
A few notes on Associative Arrays:<br /><br />
* Think of an associative array as an array with named elements<br />
* Comparisons can be exact (binary) or case insensitive (alpha)<br />
<br /><br /><br />
At the time of writing this - 28 November 2017 - a new '''map data type''' is under development for AutoIt. It is availabe in the current [https://www.autoitscript.com/forum/topic/163657-maps-beta/?do=findComment&comment=1296278 beta release].<br />
<br /><br />
<br /><br />
Please also see this entry in the Snippets section of this Wiki [https://www.autoitscript.com/wiki/Snippets_(_AutoIt_Array_)#AssocArray _AssocArray] <br />
<br /><br />
<br /><br />
<br />
A dictionary object example by [https://www.autoitscript.com/forum/profile/2709-mhz/ MHz]<br />
<syntaxhighlight lang='autoit'><br />
; Author Mhz<br />
; Forum https://www.autoitscript.com/forum/topic/182334-scripting-dictionary-modified/<br />
Global $vKey, $sItem, $sMsg, $oDictionary <br />
<br />
; Create dictionary object<br />
$oDictionary = ObjCreate("Scripting.Dictionary")<br />
<br />
If @error Then<br />
MsgBox(0, '', 'Error creating the dictionary object')<br />
Else<br />
; Add keys with items<br />
$oDictionary.Add ("One", "Same" )<br />
$oDictionary.Add ("Two", "Car" )<br />
$oDictionary.Add ("Three", "House" )<br />
$oDictionary.Add ("Four", "Boat" )<br />
<br />
If $oDictionary.Exists('One') Then<br />
; Display item<br />
MsgBox(0x0, 'Item One', $oDictionary.Item('One'), 2)<br />
; Set an item<br />
$oDictionary.Item('One') = 'Changed'<br />
; Display item<br />
MsgBox(0x20, 'Did Item One Change?', $oDictionary.Item('One'), 3)<br />
; Remove key<br />
$oDictionary.Remove('One')<br />
; <br />
$oDictionary.Key ('Two') = 'Bike'<br />
EndIf<br />
<br />
Sleep(1000)<br />
<br />
; Store items into a variable<br />
For $vKey In $oDictionary<br />
$sItem &= $oDictionary.Item($vKey) & @CRLF<br />
Next<br />
<br />
; Display items<br />
MsgBox(0x0, 'Items Count: ' & $oDictionary.Count, $sItem, 3)<br />
<br />
; Add items into an array<br />
$aItems = $oDictionary.Items<br />
<br />
; Display items in the array<br />
For $i = 0 To $oDictionary.Count -1<br />
MsgBox(0x0, 'Items [ ' & $i & ' ]', $aItems[$i], 2)<br />
Next<br />
<br />
Sleep(1000)<br />
<br />
; Add keys into an array<br />
$aKeys = $oDictionary.Keys<br />
<br />
; Display keys in the array<br />
For $i = 0 To $oDictionary.Count -1<br />
MsgBox(0x0, 'Keys [ ' & $i & ' ]', $aKeys[$i], 2)<br />
Next<br />
EndIf<br />
</syntaxhighlight><br />
<br /><br />
<br /><br />
The original AutoIt Scripting Dictionary implementation appears to have been by Gary Frost as far back as 2007. It has since been modified to the following:<br />
<br /><br />
<syntaxhighlight lang='autoit'><br />
#cs<br />
Scripting Dictionary UDF<br />
<br />
Made by GaryFrost <https://www.autoitscript.com/forum/topic/47048-scripting-dictionary/><br />
Modified by Jefrey <jefrey[at]jefrey.ml><br />
<br />
Forum https://www.autoitscript.com/forum/topic/182334-scripting-dictionary-modified/<br />
<br />
#ce<br />
<br />
Func _InitDictionary()<br />
Return ObjCreate("Scripting.Dictionary")<br />
EndFunc ;==>_InitDictionary<br />
<br />
; Adds a key and item pair to a Dictionary object.<br />
Func _AddItem($oDictionary, $v_key, $v_item)<br />
$oDictionary.ADD($v_key, $v_item)<br />
If @error Then Return SetError(1, 1, -1)<br />
EndFunc ;==>_AddItem<br />
<br />
; Returns true if a specified key exists in the Dictionary object, false if it does not.<br />
Func _ItemExists($oDictionary, $v_key)<br />
Return $oDictionary.Exists($v_key)<br />
EndFunc ;==>_ItemExists<br />
<br />
; Returns an item for a specified key in a Dictionary object<br />
Func _Item($oDictionary, $v_key)<br />
Return $oDictionary.Item($v_key)<br />
EndFunc ;==>_Item<br />
<br />
; Sets an item for a specified key in a Dictionary object<br />
Func _ChangeItem($oDictionary, $v_key, $v_item)<br />
$oDictionary.Item($v_key) = $v_item<br />
EndFunc ;==>_ChangeItem<br />
<br />
; Sets a key in a Dictionary object.<br />
Func _ChangeKey($oDictionary, $v_key, $v_newKey)<br />
$oDictionary.Key($v_key) = $v_newKey<br />
EndFunc ;==>_ChangeKey<br />
<br />
; Removes a key, item pair from a Dictionary object.<br />
Func _ItemRemove($oDictionary, $v_key)<br />
$oDictionary.Remove($v_key)<br />
If @error Then Return SetError(1, 1, -1)<br />
EndFunc ;==>_ItemRemove<br />
<br />
; Returns the number of items in a collection or Dictionary object.<br />
Func _ItemCount($oDictionary)<br />
Return $oDictionary.Count<br />
EndFunc ;==>_ItemCount<br />
<br />
; Returns an array containing all the items in a Dictionary object<br />
Func _GetItems($oDictionary)<br />
Return $oDictionary.Items<br />
EndFunc ;==>_GetItems<br />
<br />
Func _Clear($oDictionary)<br />
Return $oDictionary.RemoveAll<br />
EndFunc<br />
<br />
</syntaxhighlight><br />
<br /><br />
<br /><br />
Below are several examples that illustrate the usage of the Scripting Dictionary UDF in AutoIt.<br />
<br /><br />
Example 1:<br />
<syntaxhighlight lang='autoit'><br />
; Author Jefrey<br />
; Forum https://www.autoitscript.com/forum/profile/75137-jefrey/<br />
#include 'scriptingdic.au3'<br />
#include <Array.au3> ; Needed only for _ArrayDisplay, and not required by the lib<br />
<br />
; Init the object<br />
$oObj = _InitDictionary()<br />
<br />
; Adding a single value<br />
_AddItem($oObj, 0, "Test")<br />
; And showing it<br />
msgbox(0, '', _Item($oObj, 0))<br />
<br />
; Adding an array<br />
Dim $aArr[] = [0, -80, -49, -44, 80, 100, 8, 7, 6, 5, 4, 3, 2, 1]<br />
_AddItem($oObj, 1, $aArr)<br />
; And showing it<br />
_ArrayDisplay(_Item($oObj, 1))<br />
<br />
; We can also use this approach:<br />
$oObj3 = _InitDictionary()<br />
$oObj.Add("test", "foo")<br />
MsgBox(0, '', $oObj.Item("test"))<br />
</syntaxhighlight><br />
Example 2 is a reply to a common question asked on the Forum, How to find duplicate lines/values... <br />
<syntaxhighlight lang='autoit'><br />
; Author Malkey <br />
; https://www.autoitscript.com/forum/profile/31256-malkey/<br />
; Forum https://www.autoitscript.com/forum/topic/116156-best-way-to-compare-strings-for-duplicates/?do=findComment&comment=810752<br />
Local $sStr, $begin, $dif, $sMatches<br />
<br />
; Create random test data<br />
For $i = 1 To 1000<br />
$sStr &= Chr(Random(Asc("a"), Asc("z"), 1)) & Chr(Random(Asc("a"), Asc("z"), 1)) & _<br />
Chr(Random(Asc("a"), Asc("z"), 1)) & Chr(Random(Asc("a"), Asc("z"), 1)) & @CRLF ;<br />
Next<br />
;ConsoleWrite($sStr & @CRLF)<br />
<br />
$begin = TimerInit()<br />
<br />
Local $oDict = ObjCreate("Scripting.Dictionary") ; to create a dictionary object<br />
Local $aArray = StringSplit(StringStripWS($sStr, 2), @CRLF, 3)<br />
For $i = 0 To UBound($aArray) - 1<br />
If $oDict.Exists($aArray[$i]) Then<br />
$sMatches &= $i & " " & $aArray[$i] & @CRLF ; Record duplicates<br />
Else<br />
$oDict.add($aArray[$i], '') ; to store a string (you may set $value = '' if you have no use of it)<br />
EndIf<br />
Next<br />
$dif = Round(TimerDiff($begin) / 1000, 3) & " secs"<br />
<br />
;Display results<br />
If $sMatches <> "" Then<br />
MsgBox(0, "Results", StringTrimRight($sMatches, 2) & @CRLF & "Time taken = " & $dif)<br />
Else<br />
MsgBox(0, "Results", "No duplicates found" & @CRLF & "Time taken = " & $dif)<br />
EndIf<br />
</syntaxhighlight><br />
<br /><br />
<br /><br /><br />
_____________________________________________________<br />
<br /><br />
<br />
The next example does not use the scripting dictionary UDF, but makes use of Global Enumerators. This allows access to data through named elements.<br />
<syntaxhighlight lang='autoit'><br />
; Author guinness<br />
; Forum https://www.autoitscript.com/forum/topic/173803-oop-like-approach-in-autoit/<br />
#include <MsgBoxConstants.au3><br />
<br />
; ---- Start of Person Class<br />
<br />
; Stored in the 'object' to verify it's our 'object' and not some random array<br />
Global Const $PERSON_GUID = '4197B285-6AB1-489B-8585-08C852E33F3D'<br />
<br />
; Friendly names for 0, 1, 2 and 3<br />
Global Enum $PERSON_AGE, $PERSON_NAME, $PERSON_ID, $PERSON_MAX<br />
<br />
; Constructor<br />
Func Person($sName, $iAge)<br />
Local $hPerson[$PERSON_MAX]<br />
<br />
; Set the GUID, so as the verification will work<br />
$hPerson[$PERSON_ID] = $PERSON_GUID<br />
<br />
Person_SetAge($hPerson, $iAge)<br />
Person_SetName($hPerson, $sName)<br />
<br />
; Return the Person 'object'<br />
Return $hPerson<br />
EndFunc ;==>Person<br />
<br />
; Getter for the age property<br />
Func Person_GetAge(ByRef $hPerson)<br />
Return _Person_IsObject($hPerson) ? $hPerson[$PERSON_AGE] : Null<br />
EndFunc ;==>Person_GetAge<br />
<br />
; Setter for the age property<br />
Func Person_SetAge(ByRef $hPerson, $iAge)<br />
; If not a valid 'object' or integer then return<br />
If Not _Person_IsObject($hPerson) Or Not IsInt($iAge) Then Return<br />
<br />
; Set the age<br />
$hPerson[$PERSON_AGE] = $iAge<br />
EndFunc ;==>Person_SetAge<br />
<br />
; Getter for the name property<br />
Func Person_GetName(ByRef $hPerson)<br />
Return _Person_IsObject($hPerson) ? $hPerson[$PERSON_NAME] : Null<br />
EndFunc ;==>Person_GetName<br />
<br />
; Setter for the name property<br />
Func Person_SetName(ByRef $hPerson, $sName)<br />
; If not a valid 'object' then return<br />
If Not _Person_IsObject($hPerson) Then Return<br />
<br />
; Set the name<br />
$hPerson[$PERSON_NAME] = $sName<br />
EndFunc ;==>Person_SetName<br />
<br />
; ToString() for the 'object'<br />
Func Person_ToString(ByRef $hPerson)<br />
Return _Person_IsObject($hPerson) ? StringFormat('Name: %s, Age: %i', $hPerson[$PERSON_NAME], $hPerson[$PERSON_AGE]) : Null<br />
EndFunc ;==>Person_ToString<br />
<br />
; Check if it's a valid 'object' and not some random array. "NTERNAL ONLY!<br />
Func _Person_IsObject(ByRef $hPerson)<br />
Return UBound($hPerson) = $PERSON_MAX And $hPerson[$PERSON_ID] == $PERSON_GUID<br />
EndFunc ;==>_Person_IsObject<br />
<br />
; ---- End of Person Class<br />
<br />
Example()<br />
<br />
Func Example()<br />
; Store the Person 'object', which is just a glorified array<br />
Local $hP1 = Person('John', 30)<br />
<br />
; Display the 'object'<br />
MsgBox($MB_SYSTEMMODAL, 'Person 1', Person_ToString($hP1))<br />
<br />
; Create a new person<br />
<br />
; Store the Person 'object', which is just a glorified array<br />
Local $hP2 = Person('James', 36)<br />
<br />
; Display the 'object'<br />
MsgBox($MB_SYSTEMMODAL, 'Person 2', Person_ToString($hP2))<br />
<br />
; Set the age for Person 2<br />
Person_SetAge($hP2, 45)<br />
<br />
; Display the 'object'<br />
MsgBox($MB_SYSTEMMODAL, 'Person 2 - Revised', Person_ToString($hP2))<br />
EndFunc ;==>Example<br />
</syntaxhighlight><br />
Please see the current beta for more information on map functions.<br />
<syntaxhighlight lang='autoit'><br />
</syntaxhighlight></div>Skysnakehttps://www.autoitscript.com/w/index.php?title=Associative_Arrays&diff=13723Associative Arrays2017-11-28T14:13:29Z<p>Skysnake: </p>
<hr />
<div>In computer science, an associative array, map, symbol table, or dictionary is an abstract data type composed of a collection of (key, value) pairs, such that each possible key appears at most once in the collection.<br />
An associative array differs from a “normal” array in one major way: rather than being indexed numerically (i.e. 0, 1, 2, 3, …), it is indexed by a key, or a language-like word. <br />
A '''Scripting.Dictionary''' is a standard object provided by the '''Microsoft Scripting Runtime''' (scrrun.dll) dependency and is commonly used in VBScript, a reference to which needs to be added in order to create an object in your AutoIt project.<br />
<br />
<br /><br />
<br /><br />
A few notes on Associative Arrays:<br /><br />
* Think of an associative array as an array with named elements<br />
* Comparisons can be exact (binary) or case insensitive (alpha)<br />
<br /><br /><br />
At the time of writing this - 28 November 2017 - a new '''map data type''' is under development for AutoIt. It is availabe in the current [https://www.autoitscript.com/forum/topic/163657-maps-beta/?do=findComment&comment=1296278 beta release].<br />
<br /><br />
<br /><br />
Please also see this entry in the Snippets section of this Wiki [https://www.autoitscript.com/wiki/Snippets_(_AutoIt_Array_)#AssocArray _AssocArray] <br />
<br /><br />
<br /><br />
<br />
A dictionary object example by [https://www.autoitscript.com/forum/profile/2709-mhz/ MHz]<br />
<syntaxhighlight lang='autoit'><br />
; Author Mhz<br />
; Forum https://www.autoitscript.com/forum/topic/182334-scripting-dictionary-modified/<br />
Global $vKey, $sItem, $sMsg, $oDictionary <br />
<br />
; Create dictionary object<br />
$oDictionary = ObjCreate("Scripting.Dictionary")<br />
<br />
If @error Then<br />
MsgBox(0, '', 'Error creating the dictionary object')<br />
Else<br />
; Add keys with items<br />
$oDictionary.Add ("One", "Same" )<br />
$oDictionary.Add ("Two", "Car" )<br />
$oDictionary.Add ("Three", "House" )<br />
$oDictionary.Add ("Four", "Boat" )<br />
<br />
If $oDictionary.Exists('One') Then<br />
; Display item<br />
MsgBox(0x0, 'Item One', $oDictionary.Item('One'), 2)<br />
; Set an item<br />
$oDictionary.Item('One') = 'Changed'<br />
; Display item<br />
MsgBox(0x20, 'Did Item One Change?', $oDictionary.Item('One'), 3)<br />
; Remove key<br />
$oDictionary.Remove('One')<br />
; <br />
$oDictionary.Key ('Two') = 'Bike'<br />
EndIf<br />
<br />
Sleep(1000)<br />
<br />
; Store items into a variable<br />
For $vKey In $oDictionary<br />
$sItem &= $oDictionary.Item($vKey) & @CRLF<br />
Next<br />
<br />
; Display items<br />
MsgBox(0x0, 'Items Count: ' & $oDictionary.Count, $sItem, 3)<br />
<br />
; Add items into an array<br />
$aItems = $oDictionary.Items<br />
<br />
; Display items in the array<br />
For $i = 0 To $oDictionary.Count -1<br />
MsgBox(0x0, 'Items [ ' & $i & ' ]', $aItems[$i], 2)<br />
Next<br />
<br />
Sleep(1000)<br />
<br />
; Add keys into an array<br />
$aKeys = $oDictionary.Keys<br />
<br />
; Display keys in the array<br />
For $i = 0 To $oDictionary.Count -1<br />
MsgBox(0x0, 'Keys [ ' & $i & ' ]', $aKeys[$i], 2)<br />
Next<br />
EndIf<br />
</syntaxhighlight><br />
<br /><br />
<br /><br />
The original AutoIt Scripting Dictionary implementation appears to have been by Gary Frost as far back as 2007. It has since been modified to the following:<br />
<br /><br />
<syntaxhighlight lang='autoit'><br />
#cs<br />
Scripting Dictionary UDF<br />
<br />
Made by GaryFrost <https://www.autoitscript.com/forum/topic/47048-scripting-dictionary/><br />
Modified by Jefrey <jefrey[at]jefrey.ml><br />
<br />
Forum https://www.autoitscript.com/forum/topic/182334-scripting-dictionary-modified/<br />
<br />
#ce<br />
<br />
Func _InitDictionary()<br />
Return ObjCreate("Scripting.Dictionary")<br />
EndFunc ;==>_InitDictionary<br />
<br />
; Adds a key and item pair to a Dictionary object.<br />
Func _AddItem($oDictionary, $v_key, $v_item)<br />
$oDictionary.ADD($v_key, $v_item)<br />
If @error Then Return SetError(1, 1, -1)<br />
EndFunc ;==>_AddItem<br />
<br />
; Returns true if a specified key exists in the Dictionary object, false if it does not.<br />
Func _ItemExists($oDictionary, $v_key)<br />
Return $oDictionary.Exists($v_key)<br />
EndFunc ;==>_ItemExists<br />
<br />
; Returns an item for a specified key in a Dictionary object<br />
Func _Item($oDictionary, $v_key)<br />
Return $oDictionary.Item($v_key)<br />
EndFunc ;==>_Item<br />
<br />
; Sets an item for a specified key in a Dictionary object<br />
Func _ChangeItem($oDictionary, $v_key, $v_item)<br />
$oDictionary.Item($v_key) = $v_item<br />
EndFunc ;==>_ChangeItem<br />
<br />
; Sets a key in a Dictionary object.<br />
Func _ChangeKey($oDictionary, $v_key, $v_newKey)<br />
$oDictionary.Key($v_key) = $v_newKey<br />
EndFunc ;==>_ChangeKey<br />
<br />
; Removes a key, item pair from a Dictionary object.<br />
Func _ItemRemove($oDictionary, $v_key)<br />
$oDictionary.Remove($v_key)<br />
If @error Then Return SetError(1, 1, -1)<br />
EndFunc ;==>_ItemRemove<br />
<br />
; Returns the number of items in a collection or Dictionary object.<br />
Func _ItemCount($oDictionary)<br />
Return $oDictionary.Count<br />
EndFunc ;==>_ItemCount<br />
<br />
; Returns an array containing all the items in a Dictionary object<br />
Func _GetItems($oDictionary)<br />
Return $oDictionary.Items<br />
EndFunc ;==>_GetItems<br />
<br />
Func _Clear($oDictionary)<br />
Return $oDictionary.RemoveAll<br />
EndFunc<br />
<br />
</syntaxhighlight><br />
<br /><br />
<br /><br />
Below are several examples that illustrate the usage of the Scripting Dictionary UDF in AutoIt.<br />
<br /><br />
Example 1:<br />
<syntaxhighlight lang='autoit'><br />
; Author Jefrey<br />
; Forum https://www.autoitscript.com/forum/profile/75137-jefrey/<br />
#include 'scriptingdic.au3'<br />
#include <Array.au3> ; Needed only for _ArrayDisplay, and not required by the lib<br />
<br />
; Init the object<br />
$oObj = _InitDictionary()<br />
<br />
; Adding a single value<br />
_AddItem($oObj, 0, "Test")<br />
; And showing it<br />
msgbox(0, '', _Item($oObj, 0))<br />
<br />
; Adding an array<br />
Dim $aArr[] = [0, -80, -49, -44, 80, 100, 8, 7, 6, 5, 4, 3, 2, 1]<br />
_AddItem($oObj, 1, $aArr)<br />
; And showing it<br />
_ArrayDisplay(_Item($oObj, 1))<br />
<br />
; We can also use this approach:<br />
$oObj3 = _InitDictionary()<br />
$oObj.Add("test", "foo")<br />
MsgBox(0, '', $oObj.Item("test"))<br />
</syntaxhighlight><br />
Example 2 is a reply to a common question asked on the Forum, How to find duplicate lines/values... <br />
<syntaxhighlight lang='autoit'><br />
; Author Malkey <br />
; https://www.autoitscript.com/forum/profile/31256-malkey/<br />
; Forum https://www.autoitscript.com/forum/topic/116156-best-way-to-compare-strings-for-duplicates/?do=findComment&comment=810752<br />
Local $sStr, $begin, $dif, $sMatches<br />
<br />
; Create random test data<br />
For $i = 1 To 1000<br />
$sStr &= Chr(Random(Asc("a"), Asc("z"), 1)) & Chr(Random(Asc("a"), Asc("z"), 1)) & _<br />
Chr(Random(Asc("a"), Asc("z"), 1)) & Chr(Random(Asc("a"), Asc("z"), 1)) & @CRLF ;<br />
Next<br />
;ConsoleWrite($sStr & @CRLF)<br />
<br />
$begin = TimerInit()<br />
<br />
Local $oDict = ObjCreate("Scripting.Dictionary") ; to create a dictionary object<br />
Local $aArray = StringSplit(StringStripWS($sStr, 2), @CRLF, 3)<br />
For $i = 0 To UBound($aArray) - 1<br />
If $oDict.Exists($aArray[$i]) Then<br />
$sMatches &= $i & " " & $aArray[$i] & @CRLF ; Record duplicates<br />
Else<br />
$oDict.add($aArray[$i], '') ; to store a string (you may set $value = '' if you have no use of it)<br />
EndIf<br />
Next<br />
$dif = Round(TimerDiff($begin) / 1000, 3) & " secs"<br />
<br />
;Display results<br />
If $sMatches <> "" Then<br />
MsgBox(0, "Results", StringTrimRight($sMatches, 2) & @CRLF & "Time taken = " & $dif)<br />
Else<br />
MsgBox(0, "Results", "No duplicates found" & @CRLF & "Time taken = " & $dif)<br />
EndIf<br />
</syntaxhighlight><br />
<br /><br />
<br /><br /><br />
_____________________________________________________<br />
<br /><br />
<br />
The next example does not use the scripting dictionary UDF, but makes use of Global Enumerators. This allows access to data through named elements.<br />
<syntaxhighlight lang='autoit'><br />
; Author guinness<br />
; Forum https://www.autoitscript.com/forum/topic/173803-oop-like-approach-in-autoit/<br />
#include <MsgBoxConstants.au3><br />
<br />
; ---- Start of Person Class<br />
<br />
; Stored in the 'object' to verify it's our 'object' and not some random array<br />
Global Const $PERSON_GUID = '4197B285-6AB1-489B-8585-08C852E33F3D'<br />
<br />
; Friendly names for 0, 1, 2 and 3<br />
Global Enum $PERSON_AGE, $PERSON_NAME, $PERSON_ID, $PERSON_MAX<br />
<br />
; Constructor<br />
Func Person($sName, $iAge)<br />
Local $hPerson[$PERSON_MAX]<br />
<br />
; Set the GUID, so as the verification will work<br />
$hPerson[$PERSON_ID] = $PERSON_GUID<br />
<br />
Person_SetAge($hPerson, $iAge)<br />
Person_SetName($hPerson, $sName)<br />
<br />
; Return the Person 'object'<br />
Return $hPerson<br />
EndFunc ;==>Person<br />
<br />
; Getter for the age property<br />
Func Person_GetAge(ByRef $hPerson)<br />
Return _Person_IsObject($hPerson) ? $hPerson[$PERSON_AGE] : Null<br />
EndFunc ;==>Person_GetAge<br />
<br />
; Setter for the age property<br />
Func Person_SetAge(ByRef $hPerson, $iAge)<br />
; If not a valid 'object' or integer then return<br />
If Not _Person_IsObject($hPerson) Or Not IsInt($iAge) Then Return<br />
<br />
; Set the age<br />
$hPerson[$PERSON_AGE] = $iAge<br />
EndFunc ;==>Person_SetAge<br />
<br />
; Getter for the name property<br />
Func Person_GetName(ByRef $hPerson)<br />
Return _Person_IsObject($hPerson) ? $hPerson[$PERSON_NAME] : Null<br />
EndFunc ;==>Person_GetName<br />
<br />
; Setter for the name property<br />
Func Person_SetName(ByRef $hPerson, $sName)<br />
; If not a valid 'object' then return<br />
If Not _Person_IsObject($hPerson) Then Return<br />
<br />
; Set the name<br />
$hPerson[$PERSON_NAME] = $sName<br />
EndFunc ;==>Person_SetName<br />
<br />
; ToString() for the 'object'<br />
Func Person_ToString(ByRef $hPerson)<br />
Return _Person_IsObject($hPerson) ? StringFormat('Name: %s, Age: %i', $hPerson[$PERSON_NAME], $hPerson[$PERSON_AGE]) : Null<br />
EndFunc ;==>Person_ToString<br />
<br />
; Check if it's a valid 'object' and not some random array. "NTERNAL ONLY!<br />
Func _Person_IsObject(ByRef $hPerson)<br />
Return UBound($hPerson) = $PERSON_MAX And $hPerson[$PERSON_ID] == $PERSON_GUID<br />
EndFunc ;==>_Person_IsObject<br />
<br />
; ---- End of Person Class<br />
<br />
Example()<br />
<br />
Func Example()<br />
; Store the Person 'object', which is just a glorified array<br />
Local $hP1 = Person('John', 30)<br />
<br />
; Display the 'object'<br />
MsgBox($MB_SYSTEMMODAL, 'Person 1', Person_ToString($hP1))<br />
<br />
; Create a new person<br />
<br />
; Store the Person 'object', which is just a glorified array<br />
Local $hP2 = Person('James', 36)<br />
<br />
; Display the 'object'<br />
MsgBox($MB_SYSTEMMODAL, 'Person 2', Person_ToString($hP2))<br />
<br />
; Set the age for Person 2<br />
Person_SetAge($hP2, 45)<br />
<br />
; Display the 'object'<br />
MsgBox($MB_SYSTEMMODAL, 'Person 2 - Revised', Person_ToString($hP2))<br />
EndFunc ;==>Example<br />
</syntaxhighlight><br />
Please see the current beta for more information on map functions.<br />
<syntaxhighlight lang='autoit'><br />
</syntaxhighlight></div>Skysnakehttps://www.autoitscript.com/w/index.php?title=Associative_Arrays&diff=13722Associative Arrays2017-11-28T14:11:42Z<p>Skysnake: </p>
<hr />
<div>In computer science, an associative array, map, symbol table, or dictionary is an abstract data type composed of a collection of (key, value) pairs, such that each possible key appears at most once in the collection.<br />
An associative array differs from a “normal” array in one major way: rather than being indexed numerically (i.e. 0, 1, 2, 3, …), it is indexed by a key, or a language-like word. <br />
A '''Scripting.Dictionary''' is a standard object provided by the '''Microsoft Scripting Runtime''' (scrrun.dll) dependency and is commonly used in VBScript, a reference to which needs to be added in order to create an object in your AutoIt project.<br />
<br />
<br /><br />
<br /><br />
A few notes on Associative Arrays:<br /><br />
* Think of an associative array as an array with named elements<br />
* Comparisons can be exact (binary) or case insensitive (alpha)<br />
<br /><br /><br />
At the time of writing this - 28 November 2017 - a new '''map data type''' is under development for AutoIt. It is availabe in the current [https://www.autoitscript.com/forum/topic/163657-maps-beta/?do=findComment&comment=1296278 beta release].<br />
<br /><br />
<br /><br />
Please also see this entry in the Snippets section of this Wiki [[https://www.autoitscript.com/wiki/Snippets_(_AutoIt_Array_)#AssocArray|_AssocArray]]<br />
<br /><br />
<br /><br />
<br />
A dictionary object example by [https://www.autoitscript.com/forum/profile/2709-mhz/ MHz]<br />
<syntaxhighlight lang='autoit'><br />
; Author Mhz<br />
; Forum https://www.autoitscript.com/forum/topic/182334-scripting-dictionary-modified/<br />
Global $vKey, $sItem, $sMsg, $oDictionary <br />
<br />
; Create dictionary object<br />
$oDictionary = ObjCreate("Scripting.Dictionary")<br />
<br />
If @error Then<br />
MsgBox(0, '', 'Error creating the dictionary object')<br />
Else<br />
; Add keys with items<br />
$oDictionary.Add ("One", "Same" )<br />
$oDictionary.Add ("Two", "Car" )<br />
$oDictionary.Add ("Three", "House" )<br />
$oDictionary.Add ("Four", "Boat" )<br />
<br />
If $oDictionary.Exists('One') Then<br />
; Display item<br />
MsgBox(0x0, 'Item One', $oDictionary.Item('One'), 2)<br />
; Set an item<br />
$oDictionary.Item('One') = 'Changed'<br />
; Display item<br />
MsgBox(0x20, 'Did Item One Change?', $oDictionary.Item('One'), 3)<br />
; Remove key<br />
$oDictionary.Remove('One')<br />
; <br />
$oDictionary.Key ('Two') = 'Bike'<br />
EndIf<br />
<br />
Sleep(1000)<br />
<br />
; Store items into a variable<br />
For $vKey In $oDictionary<br />
$sItem &= $oDictionary.Item($vKey) & @CRLF<br />
Next<br />
<br />
; Display items<br />
MsgBox(0x0, 'Items Count: ' & $oDictionary.Count, $sItem, 3)<br />
<br />
; Add items into an array<br />
$aItems = $oDictionary.Items<br />
<br />
; Display items in the array<br />
For $i = 0 To $oDictionary.Count -1<br />
MsgBox(0x0, 'Items [ ' & $i & ' ]', $aItems[$i], 2)<br />
Next<br />
<br />
Sleep(1000)<br />
<br />
; Add keys into an array<br />
$aKeys = $oDictionary.Keys<br />
<br />
; Display keys in the array<br />
For $i = 0 To $oDictionary.Count -1<br />
MsgBox(0x0, 'Keys [ ' & $i & ' ]', $aKeys[$i], 2)<br />
Next<br />
EndIf<br />
</syntaxhighlight><br />
<br /><br />
<br /><br />
The original AutoIt Scripting Dictionary implementation appears to have been by Gary Frost as far back as 2007. It has since been modified to the following:<br />
<br /><br />
<syntaxhighlight lang='autoit'><br />
#cs<br />
Scripting Dictionary UDF<br />
<br />
Made by GaryFrost <https://www.autoitscript.com/forum/topic/47048-scripting-dictionary/><br />
Modified by Jefrey <jefrey[at]jefrey.ml><br />
<br />
Forum https://www.autoitscript.com/forum/topic/182334-scripting-dictionary-modified/<br />
<br />
#ce<br />
<br />
Func _InitDictionary()<br />
Return ObjCreate("Scripting.Dictionary")<br />
EndFunc ;==>_InitDictionary<br />
<br />
; Adds a key and item pair to a Dictionary object.<br />
Func _AddItem($oDictionary, $v_key, $v_item)<br />
$oDictionary.ADD($v_key, $v_item)<br />
If @error Then Return SetError(1, 1, -1)<br />
EndFunc ;==>_AddItem<br />
<br />
; Returns true if a specified key exists in the Dictionary object, false if it does not.<br />
Func _ItemExists($oDictionary, $v_key)<br />
Return $oDictionary.Exists($v_key)<br />
EndFunc ;==>_ItemExists<br />
<br />
; Returns an item for a specified key in a Dictionary object<br />
Func _Item($oDictionary, $v_key)<br />
Return $oDictionary.Item($v_key)<br />
EndFunc ;==>_Item<br />
<br />
; Sets an item for a specified key in a Dictionary object<br />
Func _ChangeItem($oDictionary, $v_key, $v_item)<br />
$oDictionary.Item($v_key) = $v_item<br />
EndFunc ;==>_ChangeItem<br />
<br />
; Sets a key in a Dictionary object.<br />
Func _ChangeKey($oDictionary, $v_key, $v_newKey)<br />
$oDictionary.Key($v_key) = $v_newKey<br />
EndFunc ;==>_ChangeKey<br />
<br />
; Removes a key, item pair from a Dictionary object.<br />
Func _ItemRemove($oDictionary, $v_key)<br />
$oDictionary.Remove($v_key)<br />
If @error Then Return SetError(1, 1, -1)<br />
EndFunc ;==>_ItemRemove<br />
<br />
; Returns the number of items in a collection or Dictionary object.<br />
Func _ItemCount($oDictionary)<br />
Return $oDictionary.Count<br />
EndFunc ;==>_ItemCount<br />
<br />
; Returns an array containing all the items in a Dictionary object<br />
Func _GetItems($oDictionary)<br />
Return $oDictionary.Items<br />
EndFunc ;==>_GetItems<br />
<br />
Func _Clear($oDictionary)<br />
Return $oDictionary.RemoveAll<br />
EndFunc<br />
<br />
</syntaxhighlight><br />
<br /><br />
<br /><br />
Below are several examples that illustrate the usage of the Scripting Dictionary UDF in AutoIt.<br />
<br /><br />
Example 1:<br />
<syntaxhighlight lang='autoit'><br />
; Author Jefrey<br />
; Forum https://www.autoitscript.com/forum/profile/75137-jefrey/<br />
#include 'scriptingdic.au3'<br />
#include <Array.au3> ; Needed only for _ArrayDisplay, and not required by the lib<br />
<br />
; Init the object<br />
$oObj = _InitDictionary()<br />
<br />
; Adding a single value<br />
_AddItem($oObj, 0, "Test")<br />
; And showing it<br />
msgbox(0, '', _Item($oObj, 0))<br />
<br />
; Adding an array<br />
Dim $aArr[] = [0, -80, -49, -44, 80, 100, 8, 7, 6, 5, 4, 3, 2, 1]<br />
_AddItem($oObj, 1, $aArr)<br />
; And showing it<br />
_ArrayDisplay(_Item($oObj, 1))<br />
<br />
; We can also use this approach:<br />
$oObj3 = _InitDictionary()<br />
$oObj.Add("test", "foo")<br />
MsgBox(0, '', $oObj.Item("test"))<br />
</syntaxhighlight><br />
Example 2 is a reply to a common question asked on the Forum, How to find duplicate lines/values... <br />
<syntaxhighlight lang='autoit'><br />
; Author Malkey <br />
; https://www.autoitscript.com/forum/profile/31256-malkey/<br />
; Forum https://www.autoitscript.com/forum/topic/116156-best-way-to-compare-strings-for-duplicates/?do=findComment&comment=810752<br />
Local $sStr, $begin, $dif, $sMatches<br />
<br />
; Create random test data<br />
For $i = 1 To 1000<br />
$sStr &= Chr(Random(Asc("a"), Asc("z"), 1)) & Chr(Random(Asc("a"), Asc("z"), 1)) & _<br />
Chr(Random(Asc("a"), Asc("z"), 1)) & Chr(Random(Asc("a"), Asc("z"), 1)) & @CRLF ;<br />
Next<br />
;ConsoleWrite($sStr & @CRLF)<br />
<br />
$begin = TimerInit()<br />
<br />
Local $oDict = ObjCreate("Scripting.Dictionary") ; to create a dictionary object<br />
Local $aArray = StringSplit(StringStripWS($sStr, 2), @CRLF, 3)<br />
For $i = 0 To UBound($aArray) - 1<br />
If $oDict.Exists($aArray[$i]) Then<br />
$sMatches &= $i & " " & $aArray[$i] & @CRLF ; Record duplicates<br />
Else<br />
$oDict.add($aArray[$i], '') ; to store a string (you may set $value = '' if you have no use of it)<br />
EndIf<br />
Next<br />
$dif = Round(TimerDiff($begin) / 1000, 3) & " secs"<br />
<br />
;Display results<br />
If $sMatches <> "" Then<br />
MsgBox(0, "Results", StringTrimRight($sMatches, 2) & @CRLF & "Time taken = " & $dif)<br />
Else<br />
MsgBox(0, "Results", "No duplicates found" & @CRLF & "Time taken = " & $dif)<br />
EndIf<br />
</syntaxhighlight><br />
<br /><br />
<br /><br /><br />
_____________________________________________________<br />
<br /><br />
<br />
The next example does not use the scripting dictionary UDF, but makes use of Global Enumerators. This allows access to data through named elements.<br />
<syntaxhighlight lang='autoit'><br />
; Author guinness<br />
; Forum https://www.autoitscript.com/forum/topic/173803-oop-like-approach-in-autoit/<br />
#include <MsgBoxConstants.au3><br />
<br />
; ---- Start of Person Class<br />
<br />
; Stored in the 'object' to verify it's our 'object' and not some random array<br />
Global Const $PERSON_GUID = '4197B285-6AB1-489B-8585-08C852E33F3D'<br />
<br />
; Friendly names for 0, 1, 2 and 3<br />
Global Enum $PERSON_AGE, $PERSON_NAME, $PERSON_ID, $PERSON_MAX<br />
<br />
; Constructor<br />
Func Person($sName, $iAge)<br />
Local $hPerson[$PERSON_MAX]<br />
<br />
; Set the GUID, so as the verification will work<br />
$hPerson[$PERSON_ID] = $PERSON_GUID<br />
<br />
Person_SetAge($hPerson, $iAge)<br />
Person_SetName($hPerson, $sName)<br />
<br />
; Return the Person 'object'<br />
Return $hPerson<br />
EndFunc ;==>Person<br />
<br />
; Getter for the age property<br />
Func Person_GetAge(ByRef $hPerson)<br />
Return _Person_IsObject($hPerson) ? $hPerson[$PERSON_AGE] : Null<br />
EndFunc ;==>Person_GetAge<br />
<br />
; Setter for the age property<br />
Func Person_SetAge(ByRef $hPerson, $iAge)<br />
; If not a valid 'object' or integer then return<br />
If Not _Person_IsObject($hPerson) Or Not IsInt($iAge) Then Return<br />
<br />
; Set the age<br />
$hPerson[$PERSON_AGE] = $iAge<br />
EndFunc ;==>Person_SetAge<br />
<br />
; Getter for the name property<br />
Func Person_GetName(ByRef $hPerson)<br />
Return _Person_IsObject($hPerson) ? $hPerson[$PERSON_NAME] : Null<br />
EndFunc ;==>Person_GetName<br />
<br />
; Setter for the name property<br />
Func Person_SetName(ByRef $hPerson, $sName)<br />
; If not a valid 'object' then return<br />
If Not _Person_IsObject($hPerson) Then Return<br />
<br />
; Set the name<br />
$hPerson[$PERSON_NAME] = $sName<br />
EndFunc ;==>Person_SetName<br />
<br />
; ToString() for the 'object'<br />
Func Person_ToString(ByRef $hPerson)<br />
Return _Person_IsObject($hPerson) ? StringFormat('Name: %s, Age: %i', $hPerson[$PERSON_NAME], $hPerson[$PERSON_AGE]) : Null<br />
EndFunc ;==>Person_ToString<br />
<br />
; Check if it's a valid 'object' and not some random array. "NTERNAL ONLY!<br />
Func _Person_IsObject(ByRef $hPerson)<br />
Return UBound($hPerson) = $PERSON_MAX And $hPerson[$PERSON_ID] == $PERSON_GUID<br />
EndFunc ;==>_Person_IsObject<br />
<br />
; ---- End of Person Class<br />
<br />
Example()<br />
<br />
Func Example()<br />
; Store the Person 'object', which is just a glorified array<br />
Local $hP1 = Person('John', 30)<br />
<br />
; Display the 'object'<br />
MsgBox($MB_SYSTEMMODAL, 'Person 1', Person_ToString($hP1))<br />
<br />
; Create a new person<br />
<br />
; Store the Person 'object', which is just a glorified array<br />
Local $hP2 = Person('James', 36)<br />
<br />
; Display the 'object'<br />
MsgBox($MB_SYSTEMMODAL, 'Person 2', Person_ToString($hP2))<br />
<br />
; Set the age for Person 2<br />
Person_SetAge($hP2, 45)<br />
<br />
; Display the 'object'<br />
MsgBox($MB_SYSTEMMODAL, 'Person 2 - Revised', Person_ToString($hP2))<br />
EndFunc ;==>Example<br />
</syntaxhighlight><br />
Please see the current beta for more information on map functions.<br />
<syntaxhighlight lang='autoit'><br />
</syntaxhighlight></div>Skysnakehttps://www.autoitscript.com/w/index.php?title=Associative_Arrays&diff=13721Associative Arrays2017-11-28T11:02:35Z<p>Skysnake: </p>
<hr />
<div>In computer science, an associative array, map, symbol table, or dictionary is an abstract data type composed of a collection of (key, value) pairs, such that each possible key appears at most once in the collection.<br />
An associative array differs from a “normal” array in one major way: rather than being indexed numerically (i.e. 0, 1, 2, 3, …), it is indexed by a key, or a language-like word. <br />
A '''Scripting.Dictionary''' is a standard object provided by the '''Microsoft Scripting Runtime''' (scrrun.dll) dependency and is commonly used in VBScript, a reference to which needs to be added in order to create an object in your AutoIt project.<br />
<br />
<br /><br />
<br /><br />
A few notes on Associative Arrays:<br /><br />
* Think of an associative array as an array with named elements<br />
* Comparisons can be exact (binary) or case insensitive (alpha)<br />
<br /><br /><br />
At the time of writing this - 28 November 2017 - a new '''map data type''' is under development for AutoIt. It is availabe in the current [https://www.autoitscript.com/forum/topic/163657-maps-beta/?do=findComment&comment=1296278 beta release].<br />
<br />
<br /><br />
<br /><br />
<br />
A dictionary object example by [https://www.autoitscript.com/forum/profile/2709-mhz/ MHz]<br />
<syntaxhighlight lang='autoit'><br />
; Author Mhz<br />
; Forum https://www.autoitscript.com/forum/topic/182334-scripting-dictionary-modified/<br />
Global $vKey, $sItem, $sMsg, $oDictionary <br />
<br />
; Create dictionary object<br />
$oDictionary = ObjCreate("Scripting.Dictionary")<br />
<br />
If @error Then<br />
MsgBox(0, '', 'Error creating the dictionary object')<br />
Else<br />
; Add keys with items<br />
$oDictionary.Add ("One", "Same" )<br />
$oDictionary.Add ("Two", "Car" )<br />
$oDictionary.Add ("Three", "House" )<br />
$oDictionary.Add ("Four", "Boat" )<br />
<br />
If $oDictionary.Exists('One') Then<br />
; Display item<br />
MsgBox(0x0, 'Item One', $oDictionary.Item('One'), 2)<br />
; Set an item<br />
$oDictionary.Item('One') = 'Changed'<br />
; Display item<br />
MsgBox(0x20, 'Did Item One Change?', $oDictionary.Item('One'), 3)<br />
; Remove key<br />
$oDictionary.Remove('One')<br />
; <br />
$oDictionary.Key ('Two') = 'Bike'<br />
EndIf<br />
<br />
Sleep(1000)<br />
<br />
; Store items into a variable<br />
For $vKey In $oDictionary<br />
$sItem &= $oDictionary.Item($vKey) & @CRLF<br />
Next<br />
<br />
; Display items<br />
MsgBox(0x0, 'Items Count: ' & $oDictionary.Count, $sItem, 3)<br />
<br />
; Add items into an array<br />
$aItems = $oDictionary.Items<br />
<br />
; Display items in the array<br />
For $i = 0 To $oDictionary.Count -1<br />
MsgBox(0x0, 'Items [ ' & $i & ' ]', $aItems[$i], 2)<br />
Next<br />
<br />
Sleep(1000)<br />
<br />
; Add keys into an array<br />
$aKeys = $oDictionary.Keys<br />
<br />
; Display keys in the array<br />
For $i = 0 To $oDictionary.Count -1<br />
MsgBox(0x0, 'Keys [ ' & $i & ' ]', $aKeys[$i], 2)<br />
Next<br />
EndIf<br />
</syntaxhighlight><br />
<br /><br />
<br /><br />
The original AutoIt Scripting Dictionary implementation appears to have been by Gary Frost as far back as 2007. It has since been modified to the following:<br />
<br /><br />
<syntaxhighlight lang='autoit'><br />
#cs<br />
Scripting Dictionary UDF<br />
<br />
Made by GaryFrost <https://www.autoitscript.com/forum/topic/47048-scripting-dictionary/><br />
Modified by Jefrey <jefrey[at]jefrey.ml><br />
<br />
Forum https://www.autoitscript.com/forum/topic/182334-scripting-dictionary-modified/<br />
<br />
#ce<br />
<br />
Func _InitDictionary()<br />
Return ObjCreate("Scripting.Dictionary")<br />
EndFunc ;==>_InitDictionary<br />
<br />
; Adds a key and item pair to a Dictionary object.<br />
Func _AddItem($oDictionary, $v_key, $v_item)<br />
$oDictionary.ADD($v_key, $v_item)<br />
If @error Then Return SetError(1, 1, -1)<br />
EndFunc ;==>_AddItem<br />
<br />
; Returns true if a specified key exists in the Dictionary object, false if it does not.<br />
Func _ItemExists($oDictionary, $v_key)<br />
Return $oDictionary.Exists($v_key)<br />
EndFunc ;==>_ItemExists<br />
<br />
; Returns an item for a specified key in a Dictionary object<br />
Func _Item($oDictionary, $v_key)<br />
Return $oDictionary.Item($v_key)<br />
EndFunc ;==>_Item<br />
<br />
; Sets an item for a specified key in a Dictionary object<br />
Func _ChangeItem($oDictionary, $v_key, $v_item)<br />
$oDictionary.Item($v_key) = $v_item<br />
EndFunc ;==>_ChangeItem<br />
<br />
; Sets a key in a Dictionary object.<br />
Func _ChangeKey($oDictionary, $v_key, $v_newKey)<br />
$oDictionary.Key($v_key) = $v_newKey<br />
EndFunc ;==>_ChangeKey<br />
<br />
; Removes a key, item pair from a Dictionary object.<br />
Func _ItemRemove($oDictionary, $v_key)<br />
$oDictionary.Remove($v_key)<br />
If @error Then Return SetError(1, 1, -1)<br />
EndFunc ;==>_ItemRemove<br />
<br />
; Returns the number of items in a collection or Dictionary object.<br />
Func _ItemCount($oDictionary)<br />
Return $oDictionary.Count<br />
EndFunc ;==>_ItemCount<br />
<br />
; Returns an array containing all the items in a Dictionary object<br />
Func _GetItems($oDictionary)<br />
Return $oDictionary.Items<br />
EndFunc ;==>_GetItems<br />
<br />
Func _Clear($oDictionary)<br />
Return $oDictionary.RemoveAll<br />
EndFunc<br />
<br />
</syntaxhighlight><br />
<br /><br />
<br /><br />
Below are several examples that illustrate the usage of the Scripting Dictionary UDF in AutoIt.<br />
<br /><br />
Example 1:<br />
<syntaxhighlight lang='autoit'><br />
; Author Jefrey<br />
; Forum https://www.autoitscript.com/forum/profile/75137-jefrey/<br />
#include 'scriptingdic.au3'<br />
#include <Array.au3> ; Needed only for _ArrayDisplay, and not required by the lib<br />
<br />
; Init the object<br />
$oObj = _InitDictionary()<br />
<br />
; Adding a single value<br />
_AddItem($oObj, 0, "Test")<br />
; And showing it<br />
msgbox(0, '', _Item($oObj, 0))<br />
<br />
; Adding an array<br />
Dim $aArr[] = [0, -80, -49, -44, 80, 100, 8, 7, 6, 5, 4, 3, 2, 1]<br />
_AddItem($oObj, 1, $aArr)<br />
; And showing it<br />
_ArrayDisplay(_Item($oObj, 1))<br />
<br />
; We can also use this approach:<br />
$oObj3 = _InitDictionary()<br />
$oObj.Add("test", "foo")<br />
MsgBox(0, '', $oObj.Item("test"))<br />
</syntaxhighlight><br />
Example 2 is a reply to a common question asked on the Forum, How to find duplicate lines/values... <br />
<syntaxhighlight lang='autoit'><br />
; Author Malkey <br />
; https://www.autoitscript.com/forum/profile/31256-malkey/<br />
; Forum https://www.autoitscript.com/forum/topic/116156-best-way-to-compare-strings-for-duplicates/?do=findComment&comment=810752<br />
Local $sStr, $begin, $dif, $sMatches<br />
<br />
; Create random test data<br />
For $i = 1 To 1000<br />
$sStr &= Chr(Random(Asc("a"), Asc("z"), 1)) & Chr(Random(Asc("a"), Asc("z"), 1)) & _<br />
Chr(Random(Asc("a"), Asc("z"), 1)) & Chr(Random(Asc("a"), Asc("z"), 1)) & @CRLF ;<br />
Next<br />
;ConsoleWrite($sStr & @CRLF)<br />
<br />
$begin = TimerInit()<br />
<br />
Local $oDict = ObjCreate("Scripting.Dictionary") ; to create a dictionary object<br />
Local $aArray = StringSplit(StringStripWS($sStr, 2), @CRLF, 3)<br />
For $i = 0 To UBound($aArray) - 1<br />
If $oDict.Exists($aArray[$i]) Then<br />
$sMatches &= $i & " " & $aArray[$i] & @CRLF ; Record duplicates<br />
Else<br />
$oDict.add($aArray[$i], '') ; to store a string (you may set $value = '' if you have no use of it)<br />
EndIf<br />
Next<br />
$dif = Round(TimerDiff($begin) / 1000, 3) & " secs"<br />
<br />
;Display results<br />
If $sMatches <> "" Then<br />
MsgBox(0, "Results", StringTrimRight($sMatches, 2) & @CRLF & "Time taken = " & $dif)<br />
Else<br />
MsgBox(0, "Results", "No duplicates found" & @CRLF & "Time taken = " & $dif)<br />
EndIf<br />
</syntaxhighlight><br />
<br /><br />
<br /><br /><br />
_____________________________________________________<br />
<br /><br />
<br />
The next example does not use the scripting dictionary UDF, but makes use of Global Enumerators. This allows access to data through named elements.<br />
<syntaxhighlight lang='autoit'><br />
; Author guinness<br />
; Forum https://www.autoitscript.com/forum/topic/173803-oop-like-approach-in-autoit/<br />
#include <MsgBoxConstants.au3><br />
<br />
; ---- Start of Person Class<br />
<br />
; Stored in the 'object' to verify it's our 'object' and not some random array<br />
Global Const $PERSON_GUID = '4197B285-6AB1-489B-8585-08C852E33F3D'<br />
<br />
; Friendly names for 0, 1, 2 and 3<br />
Global Enum $PERSON_AGE, $PERSON_NAME, $PERSON_ID, $PERSON_MAX<br />
<br />
; Constructor<br />
Func Person($sName, $iAge)<br />
Local $hPerson[$PERSON_MAX]<br />
<br />
; Set the GUID, so as the verification will work<br />
$hPerson[$PERSON_ID] = $PERSON_GUID<br />
<br />
Person_SetAge($hPerson, $iAge)<br />
Person_SetName($hPerson, $sName)<br />
<br />
; Return the Person 'object'<br />
Return $hPerson<br />
EndFunc ;==>Person<br />
<br />
; Getter for the age property<br />
Func Person_GetAge(ByRef $hPerson)<br />
Return _Person_IsObject($hPerson) ? $hPerson[$PERSON_AGE] : Null<br />
EndFunc ;==>Person_GetAge<br />
<br />
; Setter for the age property<br />
Func Person_SetAge(ByRef $hPerson, $iAge)<br />
; If not a valid 'object' or integer then return<br />
If Not _Person_IsObject($hPerson) Or Not IsInt($iAge) Then Return<br />
<br />
; Set the age<br />
$hPerson[$PERSON_AGE] = $iAge<br />
EndFunc ;==>Person_SetAge<br />
<br />
; Getter for the name property<br />
Func Person_GetName(ByRef $hPerson)<br />
Return _Person_IsObject($hPerson) ? $hPerson[$PERSON_NAME] : Null<br />
EndFunc ;==>Person_GetName<br />
<br />
; Setter for the name property<br />
Func Person_SetName(ByRef $hPerson, $sName)<br />
; If not a valid 'object' then return<br />
If Not _Person_IsObject($hPerson) Then Return<br />
<br />
; Set the name<br />
$hPerson[$PERSON_NAME] = $sName<br />
EndFunc ;==>Person_SetName<br />
<br />
; ToString() for the 'object'<br />
Func Person_ToString(ByRef $hPerson)<br />
Return _Person_IsObject($hPerson) ? StringFormat('Name: %s, Age: %i', $hPerson[$PERSON_NAME], $hPerson[$PERSON_AGE]) : Null<br />
EndFunc ;==>Person_ToString<br />
<br />
; Check if it's a valid 'object' and not some random array. "NTERNAL ONLY!<br />
Func _Person_IsObject(ByRef $hPerson)<br />
Return UBound($hPerson) = $PERSON_MAX And $hPerson[$PERSON_ID] == $PERSON_GUID<br />
EndFunc ;==>_Person_IsObject<br />
<br />
; ---- End of Person Class<br />
<br />
Example()<br />
<br />
Func Example()<br />
; Store the Person 'object', which is just a glorified array<br />
Local $hP1 = Person('John', 30)<br />
<br />
; Display the 'object'<br />
MsgBox($MB_SYSTEMMODAL, 'Person 1', Person_ToString($hP1))<br />
<br />
; Create a new person<br />
<br />
; Store the Person 'object', which is just a glorified array<br />
Local $hP2 = Person('James', 36)<br />
<br />
; Display the 'object'<br />
MsgBox($MB_SYSTEMMODAL, 'Person 2', Person_ToString($hP2))<br />
<br />
; Set the age for Person 2<br />
Person_SetAge($hP2, 45)<br />
<br />
; Display the 'object'<br />
MsgBox($MB_SYSTEMMODAL, 'Person 2 - Revised', Person_ToString($hP2))<br />
EndFunc ;==>Example<br />
</syntaxhighlight><br />
Please see the current beta for more information on map functions.<br />
<syntaxhighlight lang='autoit'><br />
</syntaxhighlight></div>Skysnakehttps://www.autoitscript.com/w/index.php?title=Associative_Arrays&diff=13720Associative Arrays2017-11-28T10:56:42Z<p>Skysnake: </p>
<hr />
<div>In computer science, an associative array, map, symbol table, or dictionary is an abstract data type composed of a collection of (key, value) pairs, such that each possible key appears at most once in the collection.<br />
An associative array differs from a “normal” array in one major way: rather than being indexed numerically (i.e. 0, 1, 2, 3, …), it is indexed by a key, or a language-like word. <br />
A '''Scripting.Dictionary''' is a standard object provided by the '''Microsoft Scripting Runtime''' (scrrun.dll) dependency and is commonly used in VBScript, a reference to which needs to be added in order to create an object in your AutoIt project.<br />
<br />
<br /><br />
<br /><br />
A few notes on Associative Arrays:<br /><br />
* Think of an associative array as an array with named elements<br />
* Comparisons can be exact (binary) or case insensitive (alpha)<br />
<br /><br /><br />
At the time of writing this - 28 November 2017 - a new '''map data type''' is under development for AutoIt. It is availabe in the current [https://www.autoitscript.com/forum/topic/163657-maps-beta/?do=findComment&comment=1296278 beta release].<br />
<br />
<br /><br />
<br /><br />
<br />
A dictionary object example by [https://www.autoitscript.com/forum/profile/2709-mhz/ MHz]<br />
<syntaxhighlight lang='autoit'><br />
; Author Mhz<br />
; Forum https://www.autoitscript.com/forum/topic/182334-scripting-dictionary-modified/<br />
Global $vKey, $sItem, $sMsg, $oDictionary <br />
<br />
; Create dictionary object<br />
$oDictionary = ObjCreate("Scripting.Dictionary")<br />
<br />
If @error Then<br />
MsgBox(0, '', 'Error creating the dictionary object')<br />
Else<br />
; Add keys with items<br />
$oDictionary.Add ("One", "Same" )<br />
$oDictionary.Add ("Two", "Car" )<br />
$oDictionary.Add ("Three", "House" )<br />
$oDictionary.Add ("Four", "Boat" )<br />
<br />
If $oDictionary.Exists('One') Then<br />
; Display item<br />
MsgBox(0x0, 'Item One', $oDictionary.Item('One'), 2)<br />
; Set an item<br />
$oDictionary.Item('One') = 'Changed'<br />
; Display item<br />
MsgBox(0x20, 'Did Item One Change?', $oDictionary.Item('One'), 3)<br />
; Remove key<br />
$oDictionary.Remove('One')<br />
; <br />
$oDictionary.Key ('Two') = 'Bike'<br />
EndIf<br />
<br />
Sleep(1000)<br />
<br />
; Store items into a variable<br />
For $vKey In $oDictionary<br />
$sItem &= $oDictionary.Item($vKey) & @CRLF<br />
Next<br />
<br />
; Display items<br />
MsgBox(0x0, 'Items Count: ' & $oDictionary.Count, $sItem, 3)<br />
<br />
; Add items into an array<br />
$aItems = $oDictionary.Items<br />
<br />
; Display items in the array<br />
For $i = 0 To $oDictionary.Count -1<br />
MsgBox(0x0, 'Items [ ' & $i & ' ]', $aItems[$i], 2)<br />
Next<br />
<br />
Sleep(1000)<br />
<br />
; Add keys into an array<br />
$aKeys = $oDictionary.Keys<br />
<br />
; Display keys in the array<br />
For $i = 0 To $oDictionary.Count -1<br />
MsgBox(0x0, 'Keys [ ' & $i & ' ]', $aKeys[$i], 2)<br />
Next<br />
EndIf<br />
</syntaxhighlight><br />
<br /><br />
<br /><br />
The original AutoIt Scripting Dictionary implementation appears to have been by Gary Frost as far back as 2007. It has since been modified to the following:<br />
<br /><br />
<syntaxhighlight lang='autoit'><br />
#cs<br />
Scripting Dictionary UDF<br />
<br />
Made by GaryFrost <https://www.autoitscript.com/forum/topic/47048-scripting-dictionary/><br />
Modified by Jefrey <jefrey[at]jefrey.ml><br />
<br />
Forum https://www.autoitscript.com/forum/topic/182334-scripting-dictionary-modified/<br />
<br />
#ce<br />
<br />
Func _InitDictionary()<br />
Return ObjCreate("Scripting.Dictionary")<br />
EndFunc ;==>_InitDictionary<br />
<br />
; Adds a key and item pair to a Dictionary object.<br />
Func _AddItem($oDictionary, $v_key, $v_item)<br />
$oDictionary.ADD($v_key, $v_item)<br />
If @error Then Return SetError(1, 1, -1)<br />
EndFunc ;==>_AddItem<br />
<br />
; Returns true if a specified key exists in the Dictionary object, false if it does not.<br />
Func _ItemExists($oDictionary, $v_key)<br />
Return $oDictionary.Exists($v_key)<br />
EndFunc ;==>_ItemExists<br />
<br />
; Returns an item for a specified key in a Dictionary object<br />
Func _Item($oDictionary, $v_key)<br />
Return $oDictionary.Item($v_key)<br />
EndFunc ;==>_Item<br />
<br />
; Sets an item for a specified key in a Dictionary object<br />
Func _ChangeItem($oDictionary, $v_key, $v_item)<br />
$oDictionary.Item($v_key) = $v_item<br />
EndFunc ;==>_ChangeItem<br />
<br />
; Sets a key in a Dictionary object.<br />
Func _ChangeKey($oDictionary, $v_key, $v_newKey)<br />
$oDictionary.Key($v_key) = $v_newKey<br />
EndFunc ;==>_ChangeKey<br />
<br />
; Removes a key, item pair from a Dictionary object.<br />
Func _ItemRemove($oDictionary, $v_key)<br />
$oDictionary.Remove($v_key)<br />
If @error Then Return SetError(1, 1, -1)<br />
EndFunc ;==>_ItemRemove<br />
<br />
; Returns the number of items in a collection or Dictionary object.<br />
Func _ItemCount($oDictionary)<br />
Return $oDictionary.Count<br />
EndFunc ;==>_ItemCount<br />
<br />
; Returns an array containing all the items in a Dictionary object<br />
Func _GetItems($oDictionary)<br />
Return $oDictionary.Items<br />
EndFunc ;==>_GetItems<br />
<br />
Func _Clear($oDictionary)<br />
Return $oDictionary.RemoveAll<br />
EndFunc<br />
<br />
</syntaxhighlight><br />
<br /><br />
<br /><br />
Below are several examples that illustrate the usage of the Scripting Dictionary UDF in AutoIt.<br />
<br /><br />
Example 1:<br />
<syntaxhighlight lang='autoit'><br />
; Author Jefrey<br />
; Forum https://www.autoitscript.com/forum/profile/75137-jefrey/<br />
#include 'scriptingdic.au3'<br />
#include <Array.au3> ; Needed only for _ArrayDisplay, and not required by the lib<br />
<br />
; Init the object<br />
$oObj = _InitDictionary()<br />
<br />
; Adding a single value<br />
_AddItem($oObj, 0, "Test")<br />
; And showing it<br />
msgbox(0, '', _Item($oObj, 0))<br />
<br />
; Adding an array<br />
Dim $aArr[] = [0, -80, -49, -44, 80, 100, 8, 7, 6, 5, 4, 3, 2, 1]<br />
_AddItem($oObj, 1, $aArr)<br />
; And showing it<br />
_ArrayDisplay(_Item($oObj, 1))<br />
<br />
; We can also use this approach:<br />
$oObj3 = _InitDictionary()<br />
$oObj.Add("test", "foo")<br />
MsgBox(0, '', $oObj.Item("test"))<br />
</syntaxhighlight><br />
Example 2 is a reply to a common question asked on the Forum, How to find duplicate lines/values... <br />
<syntaxhighlight lang='autoit'><br />
; Author Malkey <br />
; https://www.autoitscript.com/forum/profile/31256-malkey/<br />
; Forum https://www.autoitscript.com/forum/topic/116156-best-way-to-compare-strings-for-duplicates/?do=findComment&comment=810752<br />
Local $sStr, $begin, $dif, $sMatches<br />
<br />
; Create random test data<br />
For $i = 1 To 1000<br />
$sStr &= Chr(Random(Asc("a"), Asc("z"), 1)) & Chr(Random(Asc("a"), Asc("z"), 1)) & _<br />
Chr(Random(Asc("a"), Asc("z"), 1)) & Chr(Random(Asc("a"), Asc("z"), 1)) & @CRLF ;<br />
Next<br />
;ConsoleWrite($sStr & @CRLF)<br />
<br />
$begin = TimerInit()<br />
<br />
Local $oDict = ObjCreate("Scripting.Dictionary") ; to create a dictionary object<br />
Local $aArray = StringSplit(StringStripWS($sStr, 2), @CRLF, 3)<br />
For $i = 0 To UBound($aArray) - 1<br />
If $oDict.Exists($aArray[$i]) Then<br />
$sMatches &= $i & " " & $aArray[$i] & @CRLF ; Record duplicates<br />
Else<br />
$oDict.add($aArray[$i], '') ; to store a string (you may set $value = '' if you have no use of it)<br />
EndIf<br />
Next<br />
$dif = Round(TimerDiff($begin) / 1000, 3) & " secs"<br />
<br />
;Display results<br />
If $sMatches <> "" Then<br />
MsgBox(0, "Results", StringTrimRight($sMatches, 2) & @CRLF & "Time taken = " & $dif)<br />
Else<br />
MsgBox(0, "Results", "No duplicates found" & @CRLF & "Time taken = " & $dif)<br />
EndIf<br />
</syntaxhighlight><br />
<br /><br />
<br /><br />
The next example does not use the scripting dictionary UDF, but makes use of Global Enumerators. This allows access to data through named elements.<br />
<syntaxhighlight lang='autoit'><br />
; Author guinness<br />
; Forum https://www.autoitscript.com/forum/topic/173803-oop-like-approach-in-autoit/<br />
#include <MsgBoxConstants.au3><br />
<br />
; ---- Start of Person Class<br />
<br />
; Stored in the 'object' to verify it's our 'object' and not some random array<br />
Global Const $PERSON_GUID = '4197B285-6AB1-489B-8585-08C852E33F3D'<br />
<br />
; Friendly names for 0, 1, 2 and 3<br />
Global Enum $PERSON_AGE, $PERSON_NAME, $PERSON_ID, $PERSON_MAX<br />
<br />
; Constructor<br />
Func Person($sName, $iAge)<br />
Local $hPerson[$PERSON_MAX]<br />
<br />
; Set the GUID, so as the verification will work<br />
$hPerson[$PERSON_ID] = $PERSON_GUID<br />
<br />
Person_SetAge($hPerson, $iAge)<br />
Person_SetName($hPerson, $sName)<br />
<br />
; Return the Person 'object'<br />
Return $hPerson<br />
EndFunc ;==>Person<br />
<br />
; Getter for the age property<br />
Func Person_GetAge(ByRef $hPerson)<br />
Return _Person_IsObject($hPerson) ? $hPerson[$PERSON_AGE] : Null<br />
EndFunc ;==>Person_GetAge<br />
<br />
; Setter for the age property<br />
Func Person_SetAge(ByRef $hPerson, $iAge)<br />
; If not a valid 'object' or integer then return<br />
If Not _Person_IsObject($hPerson) Or Not IsInt($iAge) Then Return<br />
<br />
; Set the age<br />
$hPerson[$PERSON_AGE] = $iAge<br />
EndFunc ;==>Person_SetAge<br />
<br />
; Getter for the name property<br />
Func Person_GetName(ByRef $hPerson)<br />
Return _Person_IsObject($hPerson) ? $hPerson[$PERSON_NAME] : Null<br />
EndFunc ;==>Person_GetName<br />
<br />
; Setter for the name property<br />
Func Person_SetName(ByRef $hPerson, $sName)<br />
; If not a valid 'object' then return<br />
If Not _Person_IsObject($hPerson) Then Return<br />
<br />
; Set the name<br />
$hPerson[$PERSON_NAME] = $sName<br />
EndFunc ;==>Person_SetName<br />
<br />
; ToString() for the 'object'<br />
Func Person_ToString(ByRef $hPerson)<br />
Return _Person_IsObject($hPerson) ? StringFormat('Name: %s, Age: %i', $hPerson[$PERSON_NAME], $hPerson[$PERSON_AGE]) : Null<br />
EndFunc ;==>Person_ToString<br />
<br />
; Check if it's a valid 'object' and not some random array. "NTERNAL ONLY!<br />
Func _Person_IsObject(ByRef $hPerson)<br />
Return UBound($hPerson) = $PERSON_MAX And $hPerson[$PERSON_ID] == $PERSON_GUID<br />
EndFunc ;==>_Person_IsObject<br />
<br />
; ---- End of Person Class<br />
<br />
Example()<br />
<br />
Func Example()<br />
; Store the Person 'object', which is just a glorified array<br />
Local $hP1 = Person('John', 30)<br />
<br />
; Display the 'object'<br />
MsgBox($MB_SYSTEMMODAL, 'Person 1', Person_ToString($hP1))<br />
<br />
; Create a new person<br />
<br />
; Store the Person 'object', which is just a glorified array<br />
Local $hP2 = Person('James', 36)<br />
<br />
; Display the 'object'<br />
MsgBox($MB_SYSTEMMODAL, 'Person 2', Person_ToString($hP2))<br />
<br />
; Set the age for Person 2<br />
Person_SetAge($hP2, 45)<br />
<br />
; Display the 'object'<br />
MsgBox($MB_SYSTEMMODAL, 'Person 2 - Revised', Person_ToString($hP2))<br />
EndFunc ;==>Example<br />
</syntaxhighlight><br />
Please see the current beta for more information on map functions.<br />
<syntaxhighlight lang='autoit'><br />
</syntaxhighlight></div>Skysnakehttps://www.autoitscript.com/w/index.php?title=Associative_Arrays&diff=13719Associative Arrays2017-11-28T10:56:09Z<p>Skysnake: </p>
<hr />
<div>In computer science, an associative array, map, symbol table, or dictionary is an abstract data type composed of a collection of (key, value) pairs, such that each possible key appears at most once in the collection.<br />
An associative array differs from a “normal” array in one major way: rather than being indexed numerically (i.e. 0, 1, 2, 3, …), it is indexed by a key, or a language-like word. <br />
A '''Scripting.Dictionary'''''Italic text'' is a standard object provided by the '''Microsoft Scripting Runtime''' (scrrun.dll) dependency and is commonly used in VBScript, a reference to which needs to be added in order to create an object in your AutoIt project.<br />
<br />
<br /><br />
<br /><br />
A few notes on Associative Arrays:<br /><br />
* Think of an associative array as an array with named elements<br />
* Comparisons can be exact (binary) or case insensitive (alpha)<br />
<br /><br /><br />
At the time of writing this - 28 November 2017 - a new '''map data type''' is under development for AutoIt. It is availabe in the current [https://www.autoitscript.com/forum/topic/163657-maps-beta/?do=findComment&comment=1296278 beta release].<br />
<br />
<br /><br />
<br /><br />
<br />
A dictionary object example by [https://www.autoitscript.com/forum/profile/2709-mhz/ MHz]<br />
<syntaxhighlight lang='autoit'><br />
; Author Mhz<br />
; Forum https://www.autoitscript.com/forum/topic/182334-scripting-dictionary-modified/<br />
Global $vKey, $sItem, $sMsg, $oDictionary <br />
<br />
; Create dictionary object<br />
$oDictionary = ObjCreate("Scripting.Dictionary")<br />
<br />
If @error Then<br />
MsgBox(0, '', 'Error creating the dictionary object')<br />
Else<br />
; Add keys with items<br />
$oDictionary.Add ("One", "Same" )<br />
$oDictionary.Add ("Two", "Car" )<br />
$oDictionary.Add ("Three", "House" )<br />
$oDictionary.Add ("Four", "Boat" )<br />
<br />
If $oDictionary.Exists('One') Then<br />
; Display item<br />
MsgBox(0x0, 'Item One', $oDictionary.Item('One'), 2)<br />
; Set an item<br />
$oDictionary.Item('One') = 'Changed'<br />
; Display item<br />
MsgBox(0x20, 'Did Item One Change?', $oDictionary.Item('One'), 3)<br />
; Remove key<br />
$oDictionary.Remove('One')<br />
; <br />
$oDictionary.Key ('Two') = 'Bike'<br />
EndIf<br />
<br />
Sleep(1000)<br />
<br />
; Store items into a variable<br />
For $vKey In $oDictionary<br />
$sItem &= $oDictionary.Item($vKey) & @CRLF<br />
Next<br />
<br />
; Display items<br />
MsgBox(0x0, 'Items Count: ' & $oDictionary.Count, $sItem, 3)<br />
<br />
; Add items into an array<br />
$aItems = $oDictionary.Items<br />
<br />
; Display items in the array<br />
For $i = 0 To $oDictionary.Count -1<br />
MsgBox(0x0, 'Items [ ' & $i & ' ]', $aItems[$i], 2)<br />
Next<br />
<br />
Sleep(1000)<br />
<br />
; Add keys into an array<br />
$aKeys = $oDictionary.Keys<br />
<br />
; Display keys in the array<br />
For $i = 0 To $oDictionary.Count -1<br />
MsgBox(0x0, 'Keys [ ' & $i & ' ]', $aKeys[$i], 2)<br />
Next<br />
EndIf<br />
</syntaxhighlight><br />
<br /><br />
<br /><br />
The original AutoIt Scripting Dictionary implementation appears to have been by Gary Frost as far back as 2007. It has since been modified to the following:<br />
<br /><br />
<syntaxhighlight lang='autoit'><br />
#cs<br />
Scripting Dictionary UDF<br />
<br />
Made by GaryFrost <https://www.autoitscript.com/forum/topic/47048-scripting-dictionary/><br />
Modified by Jefrey <jefrey[at]jefrey.ml><br />
<br />
Forum https://www.autoitscript.com/forum/topic/182334-scripting-dictionary-modified/<br />
<br />
#ce<br />
<br />
Func _InitDictionary()<br />
Return ObjCreate("Scripting.Dictionary")<br />
EndFunc ;==>_InitDictionary<br />
<br />
; Adds a key and item pair to a Dictionary object.<br />
Func _AddItem($oDictionary, $v_key, $v_item)<br />
$oDictionary.ADD($v_key, $v_item)<br />
If @error Then Return SetError(1, 1, -1)<br />
EndFunc ;==>_AddItem<br />
<br />
; Returns true if a specified key exists in the Dictionary object, false if it does not.<br />
Func _ItemExists($oDictionary, $v_key)<br />
Return $oDictionary.Exists($v_key)<br />
EndFunc ;==>_ItemExists<br />
<br />
; Returns an item for a specified key in a Dictionary object<br />
Func _Item($oDictionary, $v_key)<br />
Return $oDictionary.Item($v_key)<br />
EndFunc ;==>_Item<br />
<br />
; Sets an item for a specified key in a Dictionary object<br />
Func _ChangeItem($oDictionary, $v_key, $v_item)<br />
$oDictionary.Item($v_key) = $v_item<br />
EndFunc ;==>_ChangeItem<br />
<br />
; Sets a key in a Dictionary object.<br />
Func _ChangeKey($oDictionary, $v_key, $v_newKey)<br />
$oDictionary.Key($v_key) = $v_newKey<br />
EndFunc ;==>_ChangeKey<br />
<br />
; Removes a key, item pair from a Dictionary object.<br />
Func _ItemRemove($oDictionary, $v_key)<br />
$oDictionary.Remove($v_key)<br />
If @error Then Return SetError(1, 1, -1)<br />
EndFunc ;==>_ItemRemove<br />
<br />
; Returns the number of items in a collection or Dictionary object.<br />
Func _ItemCount($oDictionary)<br />
Return $oDictionary.Count<br />
EndFunc ;==>_ItemCount<br />
<br />
; Returns an array containing all the items in a Dictionary object<br />
Func _GetItems($oDictionary)<br />
Return $oDictionary.Items<br />
EndFunc ;==>_GetItems<br />
<br />
Func _Clear($oDictionary)<br />
Return $oDictionary.RemoveAll<br />
EndFunc<br />
<br />
</syntaxhighlight><br />
<br /><br />
<br /><br />
Below are several examples that illustrate the usage of the Scripting Dictionary UDF in AutoIt.<br />
<br /><br />
Example 1:<br />
<syntaxhighlight lang='autoit'><br />
; Author Jefrey<br />
; Forum https://www.autoitscript.com/forum/profile/75137-jefrey/<br />
#include 'scriptingdic.au3'<br />
#include <Array.au3> ; Needed only for _ArrayDisplay, and not required by the lib<br />
<br />
; Init the object<br />
$oObj = _InitDictionary()<br />
<br />
; Adding a single value<br />
_AddItem($oObj, 0, "Test")<br />
; And showing it<br />
msgbox(0, '', _Item($oObj, 0))<br />
<br />
; Adding an array<br />
Dim $aArr[] = [0, -80, -49, -44, 80, 100, 8, 7, 6, 5, 4, 3, 2, 1]<br />
_AddItem($oObj, 1, $aArr)<br />
; And showing it<br />
_ArrayDisplay(_Item($oObj, 1))<br />
<br />
; We can also use this approach:<br />
$oObj3 = _InitDictionary()<br />
$oObj.Add("test", "foo")<br />
MsgBox(0, '', $oObj.Item("test"))<br />
</syntaxhighlight><br />
Example 2 is a reply to a common question asked on the Forum, How to find duplicate lines/values... <br />
<syntaxhighlight lang='autoit'><br />
; Author Malkey <br />
; https://www.autoitscript.com/forum/profile/31256-malkey/<br />
; Forum https://www.autoitscript.com/forum/topic/116156-best-way-to-compare-strings-for-duplicates/?do=findComment&comment=810752<br />
Local $sStr, $begin, $dif, $sMatches<br />
<br />
; Create random test data<br />
For $i = 1 To 1000<br />
$sStr &= Chr(Random(Asc("a"), Asc("z"), 1)) & Chr(Random(Asc("a"), Asc("z"), 1)) & _<br />
Chr(Random(Asc("a"), Asc("z"), 1)) & Chr(Random(Asc("a"), Asc("z"), 1)) & @CRLF ;<br />
Next<br />
;ConsoleWrite($sStr & @CRLF)<br />
<br />
$begin = TimerInit()<br />
<br />
Local $oDict = ObjCreate("Scripting.Dictionary") ; to create a dictionary object<br />
Local $aArray = StringSplit(StringStripWS($sStr, 2), @CRLF, 3)<br />
For $i = 0 To UBound($aArray) - 1<br />
If $oDict.Exists($aArray[$i]) Then<br />
$sMatches &= $i & " " & $aArray[$i] & @CRLF ; Record duplicates<br />
Else<br />
$oDict.add($aArray[$i], '') ; to store a string (you may set $value = '' if you have no use of it)<br />
EndIf<br />
Next<br />
$dif = Round(TimerDiff($begin) / 1000, 3) & " secs"<br />
<br />
;Display results<br />
If $sMatches <> "" Then<br />
MsgBox(0, "Results", StringTrimRight($sMatches, 2) & @CRLF & "Time taken = " & $dif)<br />
Else<br />
MsgBox(0, "Results", "No duplicates found" & @CRLF & "Time taken = " & $dif)<br />
EndIf<br />
</syntaxhighlight><br />
<br /><br />
<br /><br />
The next example does not use the scripting dictionary UDF, but makes use of Global Enumerators. This allows access to data through named elements.<br />
<syntaxhighlight lang='autoit'><br />
; Author guinness<br />
; Forum https://www.autoitscript.com/forum/topic/173803-oop-like-approach-in-autoit/<br />
#include <MsgBoxConstants.au3><br />
<br />
; ---- Start of Person Class<br />
<br />
; Stored in the 'object' to verify it's our 'object' and not some random array<br />
Global Const $PERSON_GUID = '4197B285-6AB1-489B-8585-08C852E33F3D'<br />
<br />
; Friendly names for 0, 1, 2 and 3<br />
Global Enum $PERSON_AGE, $PERSON_NAME, $PERSON_ID, $PERSON_MAX<br />
<br />
; Constructor<br />
Func Person($sName, $iAge)<br />
Local $hPerson[$PERSON_MAX]<br />
<br />
; Set the GUID, so as the verification will work<br />
$hPerson[$PERSON_ID] = $PERSON_GUID<br />
<br />
Person_SetAge($hPerson, $iAge)<br />
Person_SetName($hPerson, $sName)<br />
<br />
; Return the Person 'object'<br />
Return $hPerson<br />
EndFunc ;==>Person<br />
<br />
; Getter for the age property<br />
Func Person_GetAge(ByRef $hPerson)<br />
Return _Person_IsObject($hPerson) ? $hPerson[$PERSON_AGE] : Null<br />
EndFunc ;==>Person_GetAge<br />
<br />
; Setter for the age property<br />
Func Person_SetAge(ByRef $hPerson, $iAge)<br />
; If not a valid 'object' or integer then return<br />
If Not _Person_IsObject($hPerson) Or Not IsInt($iAge) Then Return<br />
<br />
; Set the age<br />
$hPerson[$PERSON_AGE] = $iAge<br />
EndFunc ;==>Person_SetAge<br />
<br />
; Getter for the name property<br />
Func Person_GetName(ByRef $hPerson)<br />
Return _Person_IsObject($hPerson) ? $hPerson[$PERSON_NAME] : Null<br />
EndFunc ;==>Person_GetName<br />
<br />
; Setter for the name property<br />
Func Person_SetName(ByRef $hPerson, $sName)<br />
; If not a valid 'object' then return<br />
If Not _Person_IsObject($hPerson) Then Return<br />
<br />
; Set the name<br />
$hPerson[$PERSON_NAME] = $sName<br />
EndFunc ;==>Person_SetName<br />
<br />
; ToString() for the 'object'<br />
Func Person_ToString(ByRef $hPerson)<br />
Return _Person_IsObject($hPerson) ? StringFormat('Name: %s, Age: %i', $hPerson[$PERSON_NAME], $hPerson[$PERSON_AGE]) : Null<br />
EndFunc ;==>Person_ToString<br />
<br />
; Check if it's a valid 'object' and not some random array. "NTERNAL ONLY!<br />
Func _Person_IsObject(ByRef $hPerson)<br />
Return UBound($hPerson) = $PERSON_MAX And $hPerson[$PERSON_ID] == $PERSON_GUID<br />
EndFunc ;==>_Person_IsObject<br />
<br />
; ---- End of Person Class<br />
<br />
Example()<br />
<br />
Func Example()<br />
; Store the Person 'object', which is just a glorified array<br />
Local $hP1 = Person('John', 30)<br />
<br />
; Display the 'object'<br />
MsgBox($MB_SYSTEMMODAL, 'Person 1', Person_ToString($hP1))<br />
<br />
; Create a new person<br />
<br />
; Store the Person 'object', which is just a glorified array<br />
Local $hP2 = Person('James', 36)<br />
<br />
; Display the 'object'<br />
MsgBox($MB_SYSTEMMODAL, 'Person 2', Person_ToString($hP2))<br />
<br />
; Set the age for Person 2<br />
Person_SetAge($hP2, 45)<br />
<br />
; Display the 'object'<br />
MsgBox($MB_SYSTEMMODAL, 'Person 2 - Revised', Person_ToString($hP2))<br />
EndFunc ;==>Example<br />
</syntaxhighlight><br />
Please see the current beta for more information on map functions.<br />
<syntaxhighlight lang='autoit'><br />
</syntaxhighlight></div>Skysnakehttps://www.autoitscript.com/w/index.php?title=Associative_Arrays&diff=13718Associative Arrays2017-11-28T10:50:44Z<p>Skysnake: </p>
<hr />
<div>In computer science, an associative array, map, symbol table, or dictionary is an abstract data type composed of a collection of (key, value) pairs, such that each possible key appears at most once in the collection.<br />
An associative array differs from a “normal” array in one major way: rather than being indexed numerically (i.e. 0, 1, 2, 3, …), it is indexed by a key, or a language-like word. <br />
A Scripting.Dictionary is a standard object provided by the Microsoft ScripTing Runtime (scrrun.dll) dependency and is commonly used in VBScript, a reference to which needs to be added in order to create an object in your AutoIt project.<br />
<br />
<br /><br />
<br /><br />
A few notes on Associative Arrays:<br /><br />
* Think of an associative array as an array with named elements<br />
* Comparisons can be exact (binary) or case insensitive (alpha)<br />
<br /><br /><br />
At the time of writing this - 28 November 2017 - a new '''map data type''' is under development for AutoIt. It is availabe in the current [https://www.autoitscript.com/forum/topic/163657-maps-beta/?do=findComment&comment=1296278 beta release].<br />
<br />
<br /><br />
<br /><br />
<br />
A dictionary object example by [https://www.autoitscript.com/forum/profile/2709-mhz/ MHz]<br />
<syntaxhighlight lang='autoit'><br />
; Author Mhz<br />
; Forum https://www.autoitscript.com/forum/topic/182334-scripting-dictionary-modified/<br />
Global $vKey, $sItem, $sMsg, $oDictionary <br />
<br />
; Create dictionary object<br />
$oDictionary = ObjCreate("Scripting.Dictionary")<br />
<br />
If @error Then<br />
MsgBox(0, '', 'Error creating the dictionary object')<br />
Else<br />
; Add keys with items<br />
$oDictionary.Add ("One", "Same" )<br />
$oDictionary.Add ("Two", "Car" )<br />
$oDictionary.Add ("Three", "House" )<br />
$oDictionary.Add ("Four", "Boat" )<br />
<br />
If $oDictionary.Exists('One') Then<br />
; Display item<br />
MsgBox(0x0, 'Item One', $oDictionary.Item('One'), 2)<br />
; Set an item<br />
$oDictionary.Item('One') = 'Changed'<br />
; Display item<br />
MsgBox(0x20, 'Did Item One Change?', $oDictionary.Item('One'), 3)<br />
; Remove key<br />
$oDictionary.Remove('One')<br />
; <br />
$oDictionary.Key ('Two') = 'Bike'<br />
EndIf<br />
<br />
Sleep(1000)<br />
<br />
; Store items into a variable<br />
For $vKey In $oDictionary<br />
$sItem &= $oDictionary.Item($vKey) & @CRLF<br />
Next<br />
<br />
; Display items<br />
MsgBox(0x0, 'Items Count: ' & $oDictionary.Count, $sItem, 3)<br />
<br />
; Add items into an array<br />
$aItems = $oDictionary.Items<br />
<br />
; Display items in the array<br />
For $i = 0 To $oDictionary.Count -1<br />
MsgBox(0x0, 'Items [ ' & $i & ' ]', $aItems[$i], 2)<br />
Next<br />
<br />
Sleep(1000)<br />
<br />
; Add keys into an array<br />
$aKeys = $oDictionary.Keys<br />
<br />
; Display keys in the array<br />
For $i = 0 To $oDictionary.Count -1<br />
MsgBox(0x0, 'Keys [ ' & $i & ' ]', $aKeys[$i], 2)<br />
Next<br />
EndIf<br />
</syntaxhighlight><br />
<br /><br />
<br /><br />
The original AutoIt Scripting Dictionary implementation appears to have been by Gary Frost as far back as 2007. It has since been modified to the following:<br />
<br /><br />
<syntaxhighlight lang='autoit'><br />
#cs<br />
Scripting Dictionary UDF<br />
<br />
Made by GaryFrost <https://www.autoitscript.com/forum/topic/47048-scripting-dictionary/><br />
Modified by Jefrey <jefrey[at]jefrey.ml><br />
<br />
Forum https://www.autoitscript.com/forum/topic/182334-scripting-dictionary-modified/<br />
<br />
#ce<br />
<br />
Func _InitDictionary()<br />
Return ObjCreate("Scripting.Dictionary")<br />
EndFunc ;==>_InitDictionary<br />
<br />
; Adds a key and item pair to a Dictionary object.<br />
Func _AddItem($oDictionary, $v_key, $v_item)<br />
$oDictionary.ADD($v_key, $v_item)<br />
If @error Then Return SetError(1, 1, -1)<br />
EndFunc ;==>_AddItem<br />
<br />
; Returns true if a specified key exists in the Dictionary object, false if it does not.<br />
Func _ItemExists($oDictionary, $v_key)<br />
Return $oDictionary.Exists($v_key)<br />
EndFunc ;==>_ItemExists<br />
<br />
; Returns an item for a specified key in a Dictionary object<br />
Func _Item($oDictionary, $v_key)<br />
Return $oDictionary.Item($v_key)<br />
EndFunc ;==>_Item<br />
<br />
; Sets an item for a specified key in a Dictionary object<br />
Func _ChangeItem($oDictionary, $v_key, $v_item)<br />
$oDictionary.Item($v_key) = $v_item<br />
EndFunc ;==>_ChangeItem<br />
<br />
; Sets a key in a Dictionary object.<br />
Func _ChangeKey($oDictionary, $v_key, $v_newKey)<br />
$oDictionary.Key($v_key) = $v_newKey<br />
EndFunc ;==>_ChangeKey<br />
<br />
; Removes a key, item pair from a Dictionary object.<br />
Func _ItemRemove($oDictionary, $v_key)<br />
$oDictionary.Remove($v_key)<br />
If @error Then Return SetError(1, 1, -1)<br />
EndFunc ;==>_ItemRemove<br />
<br />
; Returns the number of items in a collection or Dictionary object.<br />
Func _ItemCount($oDictionary)<br />
Return $oDictionary.Count<br />
EndFunc ;==>_ItemCount<br />
<br />
; Returns an array containing all the items in a Dictionary object<br />
Func _GetItems($oDictionary)<br />
Return $oDictionary.Items<br />
EndFunc ;==>_GetItems<br />
<br />
Func _Clear($oDictionary)<br />
Return $oDictionary.RemoveAll<br />
EndFunc<br />
<br />
</syntaxhighlight><br />
<br /><br />
<br /><br />
Below are several examples that illustrate the usage of the Scripting Dictionary UDF in AutoIt.<br />
<br /><br />
Example 1:<br />
<syntaxhighlight lang='autoit'><br />
; Author Jefrey<br />
; Forum https://www.autoitscript.com/forum/profile/75137-jefrey/<br />
#include 'scriptingdic.au3'<br />
#include <Array.au3> ; Needed only for _ArrayDisplay, and not required by the lib<br />
<br />
; Init the object<br />
$oObj = _InitDictionary()<br />
<br />
; Adding a single value<br />
_AddItem($oObj, 0, "Test")<br />
; And showing it<br />
msgbox(0, '', _Item($oObj, 0))<br />
<br />
; Adding an array<br />
Dim $aArr[] = [0, -80, -49, -44, 80, 100, 8, 7, 6, 5, 4, 3, 2, 1]<br />
_AddItem($oObj, 1, $aArr)<br />
; And showing it<br />
_ArrayDisplay(_Item($oObj, 1))<br />
<br />
; We can also use this approach:<br />
$oObj3 = _InitDictionary()<br />
$oObj.Add("test", "foo")<br />
MsgBox(0, '', $oObj.Item("test"))<br />
</syntaxhighlight><br />
Example 2 is a reply to a common question asked on the Forum, How to find duplicate lines/values... <br />
<syntaxhighlight lang='autoit'><br />
; Author Malkey <br />
; https://www.autoitscript.com/forum/profile/31256-malkey/<br />
; Forum https://www.autoitscript.com/forum/topic/116156-best-way-to-compare-strings-for-duplicates/?do=findComment&comment=810752<br />
Local $sStr, $begin, $dif, $sMatches<br />
<br />
; Create random test data<br />
For $i = 1 To 1000<br />
$sStr &= Chr(Random(Asc("a"), Asc("z"), 1)) & Chr(Random(Asc("a"), Asc("z"), 1)) & _<br />
Chr(Random(Asc("a"), Asc("z"), 1)) & Chr(Random(Asc("a"), Asc("z"), 1)) & @CRLF ;<br />
Next<br />
;ConsoleWrite($sStr & @CRLF)<br />
<br />
$begin = TimerInit()<br />
<br />
Local $oDict = ObjCreate("Scripting.Dictionary") ; to create a dictionary object<br />
Local $aArray = StringSplit(StringStripWS($sStr, 2), @CRLF, 3)<br />
For $i = 0 To UBound($aArray) - 1<br />
If $oDict.Exists($aArray[$i]) Then<br />
$sMatches &= $i & " " & $aArray[$i] & @CRLF ; Record duplicates<br />
Else<br />
$oDict.add($aArray[$i], '') ; to store a string (you may set $value = '' if you have no use of it)<br />
EndIf<br />
Next<br />
$dif = Round(TimerDiff($begin) / 1000, 3) & " secs"<br />
<br />
;Display results<br />
If $sMatches <> "" Then<br />
MsgBox(0, "Results", StringTrimRight($sMatches, 2) & @CRLF & "Time taken = " & $dif)<br />
Else<br />
MsgBox(0, "Results", "No duplicates found" & @CRLF & "Time taken = " & $dif)<br />
EndIf<br />
</syntaxhighlight><br />
<br /><br />
<br /><br />
The next example does not use the scripting dictionary UDF, but makes use of Global Enumerators. This allows access to data through named elements.<br />
<syntaxhighlight lang='autoit'><br />
; Author guinness<br />
; Forum https://www.autoitscript.com/forum/topic/173803-oop-like-approach-in-autoit/<br />
#include <MsgBoxConstants.au3><br />
<br />
; ---- Start of Person Class<br />
<br />
; Stored in the 'object' to verify it's our 'object' and not some random array<br />
Global Const $PERSON_GUID = '4197B285-6AB1-489B-8585-08C852E33F3D'<br />
<br />
; Friendly names for 0, 1, 2 and 3<br />
Global Enum $PERSON_AGE, $PERSON_NAME, $PERSON_ID, $PERSON_MAX<br />
<br />
; Constructor<br />
Func Person($sName, $iAge)<br />
Local $hPerson[$PERSON_MAX]<br />
<br />
; Set the GUID, so as the verification will work<br />
$hPerson[$PERSON_ID] = $PERSON_GUID<br />
<br />
Person_SetAge($hPerson, $iAge)<br />
Person_SetName($hPerson, $sName)<br />
<br />
; Return the Person 'object'<br />
Return $hPerson<br />
EndFunc ;==>Person<br />
<br />
; Getter for the age property<br />
Func Person_GetAge(ByRef $hPerson)<br />
Return _Person_IsObject($hPerson) ? $hPerson[$PERSON_AGE] : Null<br />
EndFunc ;==>Person_GetAge<br />
<br />
; Setter for the age property<br />
Func Person_SetAge(ByRef $hPerson, $iAge)<br />
; If not a valid 'object' or integer then return<br />
If Not _Person_IsObject($hPerson) Or Not IsInt($iAge) Then Return<br />
<br />
; Set the age<br />
$hPerson[$PERSON_AGE] = $iAge<br />
EndFunc ;==>Person_SetAge<br />
<br />
; Getter for the name property<br />
Func Person_GetName(ByRef $hPerson)<br />
Return _Person_IsObject($hPerson) ? $hPerson[$PERSON_NAME] : Null<br />
EndFunc ;==>Person_GetName<br />
<br />
; Setter for the name property<br />
Func Person_SetName(ByRef $hPerson, $sName)<br />
; If not a valid 'object' then return<br />
If Not _Person_IsObject($hPerson) Then Return<br />
<br />
; Set the name<br />
$hPerson[$PERSON_NAME] = $sName<br />
EndFunc ;==>Person_SetName<br />
<br />
; ToString() for the 'object'<br />
Func Person_ToString(ByRef $hPerson)<br />
Return _Person_IsObject($hPerson) ? StringFormat('Name: %s, Age: %i', $hPerson[$PERSON_NAME], $hPerson[$PERSON_AGE]) : Null<br />
EndFunc ;==>Person_ToString<br />
<br />
; Check if it's a valid 'object' and not some random array. "NTERNAL ONLY!<br />
Func _Person_IsObject(ByRef $hPerson)<br />
Return UBound($hPerson) = $PERSON_MAX And $hPerson[$PERSON_ID] == $PERSON_GUID<br />
EndFunc ;==>_Person_IsObject<br />
<br />
; ---- End of Person Class<br />
<br />
Example()<br />
<br />
Func Example()<br />
; Store the Person 'object', which is just a glorified array<br />
Local $hP1 = Person('John', 30)<br />
<br />
; Display the 'object'<br />
MsgBox($MB_SYSTEMMODAL, 'Person 1', Person_ToString($hP1))<br />
<br />
; Create a new person<br />
<br />
; Store the Person 'object', which is just a glorified array<br />
Local $hP2 = Person('James', 36)<br />
<br />
; Display the 'object'<br />
MsgBox($MB_SYSTEMMODAL, 'Person 2', Person_ToString($hP2))<br />
<br />
; Set the age for Person 2<br />
Person_SetAge($hP2, 45)<br />
<br />
; Display the 'object'<br />
MsgBox($MB_SYSTEMMODAL, 'Person 2 - Revised', Person_ToString($hP2))<br />
EndFunc ;==>Example<br />
</syntaxhighlight><br />
Please see the current beta for more information on map functions.<br />
<syntaxhighlight lang='autoit'><br />
</syntaxhighlight></div>Skysnakehttps://www.autoitscript.com/w/index.php?title=Associative_Arrays&diff=13717Associative Arrays2017-11-28T10:44:43Z<p>Skysnake: </p>
<hr />
<div>In computer science, an associative array, map, symbol table, or dictionary is an abstract data type composed of a collection of (key, value) pairs, such that each possible key appears at most once in the collection.<br />
An associative array differs from a “normal” array in one major way: rather than being indexed numerically (i.e. 0, 1, 2, 3, …), it is indexed by a key, or a language-like word. <br />
A Scripting.Dictionary is a standard object provided by the Microsoft ScripTing Runtime (scrrun.dll) dependency and is commonly used in VBScript, a reference to which needs to be added in order to create an object in your AutoIt project.<br />
<br />
<br /><br />
<br /><br />
A few notes on Associative Arrays:<br /><br />
* Think of an associative array as an array with named elements<br />
* Comparisons can be exact (binary) or case insensitive (alpha)<br />
<br /><br /><br />
At the time of writing this - 28 November 2017 - a new '''map data type''' is under development for AutoIt. It is availabe in the current [https://www.autoitscript.com/forum/topic/163657-maps-beta/?do=findComment&comment=1296278 beta release].<br />
<br />
<br /><br />
<br /><br />
<br />
A dictionary object example by [https://www.autoitscript.com/forum/profile/2709-mhz/ MHz]<br />
<syntaxhighlight lang='autoit'><br />
; Author Mhz<br />
; Forum https://www.autoitscript.com/forum/topic/182334-scripting-dictionary-modified/<br />
Global $vKey, $sItem, $sMsg, $oDictionary <br />
<br />
; Create dictionary object<br />
$oDictionary = ObjCreate("Scripting.Dictionary")<br />
<br />
If @error Then<br />
MsgBox(0, '', 'Error creating the dictionary object')<br />
Else<br />
; Add keys with items<br />
$oDictionary.Add ("One", "Same" )<br />
$oDictionary.Add ("Two", "Car" )<br />
$oDictionary.Add ("Three", "House" )<br />
$oDictionary.Add ("Four", "Boat" )<br />
<br />
If $oDictionary.Exists('One') Then<br />
; Display item<br />
MsgBox(0x0, 'Item One', $oDictionary.Item('One'), 2)<br />
; Set an item<br />
$oDictionary.Item('One') = 'Changed'<br />
; Display item<br />
MsgBox(0x20, 'Did Item One Change?', $oDictionary.Item('One'), 3)<br />
; Remove key<br />
$oDictionary.Remove('One')<br />
; <br />
$oDictionary.Key ('Two') = 'Bike'<br />
EndIf<br />
<br />
Sleep(1000)<br />
<br />
; Store items into a variable<br />
For $vKey In $oDictionary<br />
$sItem &= $oDictionary.Item($vKey) & @CRLF<br />
Next<br />
<br />
; Display items<br />
MsgBox(0x0, 'Items Count: ' & $oDictionary.Count, $sItem, 3)<br />
<br />
; Add items into an array<br />
$aItems = $oDictionary.Items<br />
<br />
; Display items in the array<br />
For $i = 0 To $oDictionary.Count -1<br />
MsgBox(0x0, 'Items [ ' & $i & ' ]', $aItems[$i], 2)<br />
Next<br />
<br />
Sleep(1000)<br />
<br />
; Add keys into an array<br />
$aKeys = $oDictionary.Keys<br />
<br />
; Display keys in the array<br />
For $i = 0 To $oDictionary.Count -1<br />
MsgBox(0x0, 'Keys [ ' & $i & ' ]', $aKeys[$i], 2)<br />
Next<br />
EndIf<br />
</syntaxhighlight><br />
<br /><br />
<br /><br />
The original AutoIt Scripting Dictionary implementation appears to have been by Gary Frost as far back as 2007. It has since been modified to the following:<br />
<br /><br />
<syntaxhighlight lang='autoit'><br />
#cs<br />
Scripting Dictionary UDF<br />
<br />
Made by GaryFrost <https://www.autoitscript.com/forum/topic/47048-scripting-dictionary/><br />
Modified by Jefrey <jefrey[at]jefrey.ml><br />
<br />
Forum https://www.autoitscript.com/forum/topic/182334-scripting-dictionary-modified/<br />
<br />
#ce<br />
<br />
Func _InitDictionary()<br />
Return ObjCreate("Scripting.Dictionary")<br />
EndFunc ;==>_InitDictionary<br />
<br />
; Adds a key and item pair to a Dictionary object.<br />
Func _AddItem($oDictionary, $v_key, $v_item)<br />
$oDictionary.ADD($v_key, $v_item)<br />
If @error Then Return SetError(1, 1, -1)<br />
EndFunc ;==>_AddItem<br />
<br />
; Returns true if a specified key exists in the Dictionary object, false if it does not.<br />
Func _ItemExists($oDictionary, $v_key)<br />
Return $oDictionary.Exists($v_key)<br />
EndFunc ;==>_ItemExists<br />
<br />
; Returns an item for a specified key in a Dictionary object<br />
Func _Item($oDictionary, $v_key)<br />
Return $oDictionary.Item($v_key)<br />
EndFunc ;==>_Item<br />
<br />
; Sets an item for a specified key in a Dictionary object<br />
Func _ChangeItem($oDictionary, $v_key, $v_item)<br />
$oDictionary.Item($v_key) = $v_item<br />
EndFunc ;==>_ChangeItem<br />
<br />
; Sets a key in a Dictionary object.<br />
Func _ChangeKey($oDictionary, $v_key, $v_newKey)<br />
$oDictionary.Key($v_key) = $v_newKey<br />
EndFunc ;==>_ChangeKey<br />
<br />
; Removes a key, item pair from a Dictionary object.<br />
Func _ItemRemove($oDictionary, $v_key)<br />
$oDictionary.Remove($v_key)<br />
If @error Then Return SetError(1, 1, -1)<br />
EndFunc ;==>_ItemRemove<br />
<br />
; Returns the number of items in a collection or Dictionary object.<br />
Func _ItemCount($oDictionary)<br />
Return $oDictionary.Count<br />
EndFunc ;==>_ItemCount<br />
<br />
; Returns an array containing all the items in a Dictionary object<br />
Func _GetItems($oDictionary)<br />
Return $oDictionary.Items<br />
EndFunc ;==>_GetItems<br />
<br />
Func _Clear($oDictionary)<br />
Return $oDictionary.RemoveAll<br />
EndFunc<br />
<br />
</syntaxhighlight><br />
<br /><br />
<br /><br />
Below are several examples that illustrate the usage of the Scripting Dictionary UDF in AutoIt.<br />
<br /><br />
Example 1:<br />
<syntaxhighlight lang='autoit'><br />
; Author Jefrey<br />
; Forum https://www.autoitscript.com/forum/profile/75137-jefrey/<br />
#include 'scriptingdic.au3'<br />
#include <Array.au3> ; Needed only for _ArrayDisplay, and not required by the lib<br />
<br />
; Init the object<br />
$oObj = _InitDictionary()<br />
<br />
; Adding a single value<br />
_AddItem($oObj, 0, "Test")<br />
; And showing it<br />
msgbox(0, '', _Item($oObj, 0))<br />
<br />
; Adding an array<br />
Dim $aArr[] = [0, -80, -49, -44, 80, 100, 8, 7, 6, 5, 4, 3, 2, 1]<br />
_AddItem($oObj, 1, $aArr)<br />
; And showing it<br />
_ArrayDisplay(_Item($oObj, 1))<br />
<br />
; We can also use this approach:<br />
$oObj3 = _InitDictionary()<br />
$oObj.Add("test", "foo")<br />
MsgBox(0, '', $oObj.Item("test"))<br />
</syntaxhighlight><br />
Example 2 is a reply to a common question asked on the Forum, How to find duplicate lines/values... <br />
<syntaxhighlight lang='autoit'><br />
; Author Malkey <br />
; https://www.autoitscript.com/forum/profile/31256-malkey/<br />
; Forum https://www.autoitscript.com/forum/topic/116156-best-way-to-compare-strings-for-duplicates/?do=findComment&comment=810752<br />
Local $sStr, $begin, $dif, $sMatches<br />
<br />
; Create random test data<br />
For $i = 1 To 1000<br />
$sStr &= Chr(Random(Asc("a"), Asc("z"), 1)) & Chr(Random(Asc("a"), Asc("z"), 1)) & _<br />
Chr(Random(Asc("a"), Asc("z"), 1)) & Chr(Random(Asc("a"), Asc("z"), 1)) & @CRLF ;<br />
Next<br />
;ConsoleWrite($sStr & @CRLF)<br />
<br />
$begin = TimerInit()<br />
<br />
Local $oDict = ObjCreate("Scripting.Dictionary") ; to create a dictionary object<br />
Local $aArray = StringSplit(StringStripWS($sStr, 2), @CRLF, 3)<br />
For $i = 0 To UBound($aArray) - 1<br />
If $oDict.Exists($aArray[$i]) Then<br />
$sMatches &= $i & " " & $aArray[$i] & @CRLF ; Record duplicates<br />
Else<br />
$oDict.add($aArray[$i], '') ; to store a string (you may set $value = '' if you have no use of it)<br />
EndIf<br />
Next<br />
$dif = Round(TimerDiff($begin) / 1000, 3) & " secs"<br />
<br />
;Display results<br />
If $sMatches <> "" Then<br />
MsgBox(0, "Results", StringTrimRight($sMatches, 2) & @CRLF & "Time taken = " & $dif)<br />
Else<br />
MsgBox(0, "Results", "No duplicates found" & @CRLF & "Time taken = " & $dif)<br />
EndIf<br />
</syntaxhighlight><br />
<br /><br />
<br />
Please see the current beta for more information on map functions.<br />
<syntaxhighlight lang='autoit'><br />
</syntaxhighlight></div>Skysnakehttps://www.autoitscript.com/w/index.php?title=Associative_Arrays&diff=13716Associative Arrays2017-11-28T10:30:10Z<p>Skysnake: </p>
<hr />
<div>In computer science, an associative array, map, symbol table, or dictionary is an abstract data type composed of a collection of (key, value) pairs, such that each possible key appears at most once in the collection.<br />
An associative array differs from a “normal” array in one major way: rather than being indexed numerically (i.e. 0, 1, 2, 3, …), it is indexed by a key, or a language-like word. <br />
A Scripting.Dictionary is a standard object provided by the Microsoft ScripTing Runtime (scrrun.dll) dependency and is commonly used in VBScript, a reference to which needs to be added in order to create an object in your AutoIt project.<br />
<br /><br /><br />
<br />
A dictionary object example by [https://www.autoitscript.com/forum/profile/2709-mhz/ MHz]<br />
<syntaxhighlight lang='autoit'><br />
; Author Mhz<br />
; Forum <br />
Global $vKey, $sItem, $sMsg, $oDictionary <br />
<br />
; Create dictionary object<br />
$oDictionary = ObjCreate("Scripting.Dictionary")<br />
<br />
If @error Then<br />
MsgBox(0, '', 'Error creating the dictionary object')<br />
Else<br />
; Add keys with items<br />
$oDictionary.Add ("One", "Same" )<br />
$oDictionary.Add ("Two", "Car" )<br />
$oDictionary.Add ("Three", "House" )<br />
$oDictionary.Add ("Four", "Boat" )<br />
<br />
If $oDictionary.Exists('One') Then<br />
; Display item<br />
MsgBox(0x0, 'Item One', $oDictionary.Item('One'), 2)<br />
; Set an item<br />
$oDictionary.Item('One') = 'Changed'<br />
; Display item<br />
MsgBox(0x20, 'Did Item One Change?', $oDictionary.Item('One'), 3)<br />
; Remove key<br />
$oDictionary.Remove('One')<br />
; <br />
$oDictionary.Key ('Two') = 'Bike'<br />
EndIf<br />
<br />
Sleep(1000)<br />
<br />
; Store items into a variable<br />
For $vKey In $oDictionary<br />
$sItem &= $oDictionary.Item($vKey) & @CRLF<br />
Next<br />
<br />
; Display items<br />
MsgBox(0x0, 'Items Count: ' & $oDictionary.Count, $sItem, 3)<br />
<br />
; Add items into an array<br />
$aItems = $oDictionary.Items<br />
<br />
; Display items in the array<br />
For $i = 0 To $oDictionary.Count -1<br />
MsgBox(0x0, 'Items [ ' & $i & ' ]', $aItems[$i], 2)<br />
Next<br />
<br />
Sleep(1000)<br />
<br />
; Add keys into an array<br />
$aKeys = $oDictionary.Keys<br />
<br />
; Display keys in the array<br />
For $i = 0 To $oDictionary.Count -1<br />
MsgBox(0x0, 'Keys [ ' & $i & ' ]', $aKeys[$i], 2)<br />
Next<br />
EndIf<br />
</syntaxhighlight><br />
<br /><br />
<br /><br />
The original AutoIt Scripting Dictionary implementation appears to have been by Gary Frost as far back as 2007. It has since been modified to the following:<br />
<br /><br />
<syntaxhighlight lang='autoit'><br />
#cs<br />
Scripting Dictionary UDF<br />
<br />
Made by GaryFrost <https://www.autoitscript.com/forum/topic/47048-scripting-dictionary/><br />
Modified by Jefrey <jefrey[at]jefrey.ml><br />
<br />
Forum https://www.autoitscript.com/forum/topic/182334-scripting-dictionary-modified/<br />
<br />
#ce<br />
<br />
Func _InitDictionary()<br />
Return ObjCreate("Scripting.Dictionary")<br />
EndFunc ;==>_InitDictionary<br />
<br />
; Adds a key and item pair to a Dictionary object.<br />
Func _AddItem($oDictionary, $v_key, $v_item)<br />
$oDictionary.ADD($v_key, $v_item)<br />
If @error Then Return SetError(1, 1, -1)<br />
EndFunc ;==>_AddItem<br />
<br />
; Returns true if a specified key exists in the Dictionary object, false if it does not.<br />
Func _ItemExists($oDictionary, $v_key)<br />
Return $oDictionary.Exists($v_key)<br />
EndFunc ;==>_ItemExists<br />
<br />
; Returns an item for a specified key in a Dictionary object<br />
Func _Item($oDictionary, $v_key)<br />
Return $oDictionary.Item($v_key)<br />
EndFunc ;==>_Item<br />
<br />
; Sets an item for a specified key in a Dictionary object<br />
Func _ChangeItem($oDictionary, $v_key, $v_item)<br />
$oDictionary.Item($v_key) = $v_item<br />
EndFunc ;==>_ChangeItem<br />
<br />
; Sets a key in a Dictionary object.<br />
Func _ChangeKey($oDictionary, $v_key, $v_newKey)<br />
$oDictionary.Key($v_key) = $v_newKey<br />
EndFunc ;==>_ChangeKey<br />
<br />
; Removes a key, item pair from a Dictionary object.<br />
Func _ItemRemove($oDictionary, $v_key)<br />
$oDictionary.Remove($v_key)<br />
If @error Then Return SetError(1, 1, -1)<br />
EndFunc ;==>_ItemRemove<br />
<br />
; Returns the number of items in a collection or Dictionary object.<br />
Func _ItemCount($oDictionary)<br />
Return $oDictionary.Count<br />
EndFunc ;==>_ItemCount<br />
<br />
; Returns an array containing all the items in a Dictionary object<br />
Func _GetItems($oDictionary)<br />
Return $oDictionary.Items<br />
EndFunc ;==>_GetItems<br />
<br />
Func _Clear($oDictionary)<br />
Return $oDictionary.RemoveAll<br />
EndFunc<br />
<br />
</syntaxhighlight><br />
<br /><br />
<br /><br />
Below are several examples that illustrate the usage of the Scripting Dictionary UDF in AutoIt.<br />
<br /><br />
Example 1:<br />
<syntaxhighlight lang='autoit'><br />
; Author Jefrey<br />
; Forum https://www.autoitscript.com/forum/profile/75137-jefrey/<br />
#include 'scriptingdic.au3'<br />
#include <Array.au3> ; Needed only for _ArrayDisplay, and not required by the lib<br />
<br />
; Init the object<br />
$oObj = _InitDictionary()<br />
<br />
; Adding a single value<br />
_AddItem($oObj, 0, "Test")<br />
; And showing it<br />
msgbox(0, '', _Item($oObj, 0))<br />
<br />
; Adding an array<br />
Dim $aArr[] = [0, -80, -49, -44, 80, 100, 8, 7, 6, 5, 4, 3, 2, 1]<br />
_AddItem($oObj, 1, $aArr)<br />
; And showing it<br />
_ArrayDisplay(_Item($oObj, 1))<br />
<br />
; We can also use this approach:<br />
$oObj3 = _InitDictionary()<br />
$oObj.Add("test", "foo")<br />
MsgBox(0, '', $oObj.Item("test"))<br />
</syntaxhighlight><br />
Example 2 is a reply to a common question asked on the Forum, How to find duplicate lines/values... <br />
<syntaxhighlight lang='autoit'><br />
; Author Malkey <br />
; https://www.autoitscript.com/forum/profile/31256-malkey/<br />
; Forum https://www.autoitscript.com/forum/topic/116156-best-way-to-compare-strings-for-duplicates/?do=findComment&comment=810752<br />
Local $sStr, $begin, $dif, $sMatches<br />
<br />
; Create random test data<br />
For $i = 1 To 1000<br />
$sStr &= Chr(Random(Asc("a"), Asc("z"), 1)) & Chr(Random(Asc("a"), Asc("z"), 1)) & _<br />
Chr(Random(Asc("a"), Asc("z"), 1)) & Chr(Random(Asc("a"), Asc("z"), 1)) & @CRLF ;<br />
Next<br />
;ConsoleWrite($sStr & @CRLF)<br />
<br />
$begin = TimerInit()<br />
<br />
Local $oDict = ObjCreate("Scripting.Dictionary") ; to create a dictionary object<br />
Local $aArray = StringSplit(StringStripWS($sStr, 2), @CRLF, 3)<br />
For $i = 0 To UBound($aArray) - 1<br />
If $oDict.Exists($aArray[$i]) Then<br />
$sMatches &= $i & " " & $aArray[$i] & @CRLF ; Record duplicates<br />
Else<br />
$oDict.add($aArray[$i], '') ; to store a string (you may set $value = '' if you have no use of it)<br />
EndIf<br />
Next<br />
$dif = Round(TimerDiff($begin) / 1000, 3) & " secs"<br />
<br />
;Display results<br />
If $sMatches <> "" Then<br />
MsgBox(0, "Results", StringTrimRight($sMatches, 2) & @CRLF & "Time taken = " & $dif)<br />
Else<br />
MsgBox(0, "Results", "No duplicates found" & @CRLF & "Time taken = " & $dif)<br />
EndIf<br />
</syntaxhighlight><br />
...<br />
<syntaxhighlight lang='autoit'><br />
<br />
</syntaxhighlight></div>Skysnakehttps://www.autoitscript.com/w/index.php?title=Associative_Arrays&diff=13715Associative Arrays2017-11-28T10:27:00Z<p>Skysnake: </p>
<hr />
<div>In computer science, an associative array, map, symbol table, or dictionary is an abstract data type composed of a collection of (key, value) pairs, such that each possible key appears at most once in the collection.<br />
An associative array differs from a “normal” array in one major way: rather than being indexed numerically (i.e. 0, 1, 2, 3, …), it is indexed by a key, or a language-like word. <br />
A Scripting.Dictionary is a standard object provided by the Microsoft ScripTing Runtime (scrrun.dll) dependency and is commonly used in VBScript, a reference to which needs to be added in order to create an object in your AutoIt project.<br />
<br /><br /><br />
<br />
A dictionary object example by [https://www.autoitscript.com/forum/profile/2709-mhz/ MHz]<br />
<syntaxhighlight lang='autoit'><br />
; Author Mhz<br />
; Forum <br />
Global $vKey, $sItem, $sMsg, $oDictionary <br />
<br />
; Create dictionary object<br />
$oDictionary = ObjCreate("Scripting.Dictionary")<br />
<br />
If @error Then<br />
MsgBox(0, '', 'Error creating the dictionary object')<br />
Else<br />
; Add keys with items<br />
$oDictionary.Add ("One", "Same" )<br />
$oDictionary.Add ("Two", "Car" )<br />
$oDictionary.Add ("Three", "House" )<br />
$oDictionary.Add ("Four", "Boat" )<br />
<br />
If $oDictionary.Exists('One') Then<br />
; Display item<br />
MsgBox(0x0, 'Item One', $oDictionary.Item('One'), 2)<br />
; Set an item<br />
$oDictionary.Item('One') = 'Changed'<br />
; Display item<br />
MsgBox(0x20, 'Did Item One Change?', $oDictionary.Item('One'), 3)<br />
; Remove key<br />
$oDictionary.Remove('One')<br />
; <br />
$oDictionary.Key ('Two') = 'Bike'<br />
EndIf<br />
<br />
Sleep(1000)<br />
<br />
; Store items into a variable<br />
For $vKey In $oDictionary<br />
$sItem &= $oDictionary.Item($vKey) & @CRLF<br />
Next<br />
<br />
; Display items<br />
MsgBox(0x0, 'Items Count: ' & $oDictionary.Count, $sItem, 3)<br />
<br />
; Add items into an array<br />
$aItems = $oDictionary.Items<br />
<br />
; Display items in the array<br />
For $i = 0 To $oDictionary.Count -1<br />
MsgBox(0x0, 'Items [ ' & $i & ' ]', $aItems[$i], 2)<br />
Next<br />
<br />
Sleep(1000)<br />
<br />
; Add keys into an array<br />
$aKeys = $oDictionary.Keys<br />
<br />
; Display keys in the array<br />
For $i = 0 To $oDictionary.Count -1<br />
MsgBox(0x0, 'Keys [ ' & $i & ' ]', $aKeys[$i], 2)<br />
Next<br />
EndIf<br />
</syntaxhighlight><br />
<br /><br />
<br /><br />
The original AutoIt Scripting Dictionary implementation appears to have been by Gary Frost as far back as 2007. It has since been modified to the following:<br />
<br /><br />
<syntaxhighlight lang='autoit'><br />
#cs<br />
Scripting Dictionary UDF<br />
<br />
Made by GaryFrost <https://www.autoitscript.com/forum/topic/47048-scripting-dictionary/><br />
Modified by Jefrey <jefrey[at]jefrey.ml><br />
<br />
Forum https://www.autoitscript.com/forum/topic/182334-scripting-dictionary-modified/<br />
<br />
#ce<br />
<br />
Func _InitDictionary()<br />
Return ObjCreate("Scripting.Dictionary")<br />
EndFunc ;==>_InitDictionary<br />
<br />
; Adds a key and item pair to a Dictionary object.<br />
Func _AddItem($oDictionary, $v_key, $v_item)<br />
$oDictionary.ADD($v_key, $v_item)<br />
If @error Then Return SetError(1, 1, -1)<br />
EndFunc ;==>_AddItem<br />
<br />
; Returns true if a specified key exists in the Dictionary object, false if it does not.<br />
Func _ItemExists($oDictionary, $v_key)<br />
Return $oDictionary.Exists($v_key)<br />
EndFunc ;==>_ItemExists<br />
<br />
; Returns an item for a specified key in a Dictionary object<br />
Func _Item($oDictionary, $v_key)<br />
Return $oDictionary.Item($v_key)<br />
EndFunc ;==>_Item<br />
<br />
; Sets an item for a specified key in a Dictionary object<br />
Func _ChangeItem($oDictionary, $v_key, $v_item)<br />
$oDictionary.Item($v_key) = $v_item<br />
EndFunc ;==>_ChangeItem<br />
<br />
; Sets a key in a Dictionary object.<br />
Func _ChangeKey($oDictionary, $v_key, $v_newKey)<br />
$oDictionary.Key($v_key) = $v_newKey<br />
EndFunc ;==>_ChangeKey<br />
<br />
; Removes a key, item pair from a Dictionary object.<br />
Func _ItemRemove($oDictionary, $v_key)<br />
$oDictionary.Remove($v_key)<br />
If @error Then Return SetError(1, 1, -1)<br />
EndFunc ;==>_ItemRemove<br />
<br />
; Returns the number of items in a collection or Dictionary object.<br />
Func _ItemCount($oDictionary)<br />
Return $oDictionary.Count<br />
EndFunc ;==>_ItemCount<br />
<br />
; Returns an array containing all the items in a Dictionary object<br />
Func _GetItems($oDictionary)<br />
Return $oDictionary.Items<br />
EndFunc ;==>_GetItems<br />
<br />
Func _Clear($oDictionary)<br />
Return $oDictionary.RemoveAll<br />
EndFunc<br />
<br />
</syntaxhighlight><br />
<br /><br />
<br /><br />
Below are several examples that illustrate the usage of the Scripting Dictionary UDF in AutoIt.<br />
<br /><br />
Example 1:<br />
<syntaxhighlight lang='autoit'><br />
; Author Jefrey<br />
; Forum https://www.autoitscript.com/forum/profile/75137-jefrey/<br />
#include 'scriptingdic.au3'<br />
#include <Array.au3> ; Needed only for _ArrayDisplay, and not required by the lib<br />
<br />
; Init the object<br />
$oObj = _InitDictionary()<br />
<br />
; Adding a single value<br />
_AddItem($oObj, 0, "Test")<br />
; And showing it<br />
msgbox(0, '', _Item($oObj, 0))<br />
<br />
; Adding an array<br />
Dim $aArr[] = [0, -80, -49, -44, 80, 100, 8, 7, 6, 5, 4, 3, 2, 1]<br />
_AddItem($oObj, 1, $aArr)<br />
; And showing it<br />
_ArrayDisplay(_Item($oObj, 1))<br />
<br />
; We can also use this approach:<br />
$oObj3 = _InitDictionary()<br />
$oObj.Add("test", "foo")<br />
MsgBox(0, '', $oObj.Item("test"))<br />
</syntaxhighlight><br />
...<br />
<syntaxhighlight lang='autoit'><br />
<br />
</syntaxhighlight></div>Skysnakehttps://www.autoitscript.com/w/index.php?title=Associative_Arrays&diff=13714Associative Arrays2017-11-28T10:24:05Z<p>Skysnake: </p>
<hr />
<div>In computer science, an associative array, map, symbol table, or dictionary is an abstract data type composed of a collection of (key, value) pairs, such that each possible key appears at most once in the collection.<br />
An associative array differs from a “normal” array in one major way: rather than being indexed numerically (i.e. 0, 1, 2, 3, …), it is indexed by a key, or a language-like word. <br />
A Scripting.Dictionary is a standard object provided by the Microsoft ScripTing Runtime (scrrun.dll) dependency and is commonly used in VBScript, a reference to which needs to be added in order to create an object in your AutoIt project.<br />
<br /><br /><br />
<br />
A dictionary object example by [https://www.autoitscript.com/forum/profile/2709-mhz/ MHz]<br />
<syntaxhighlight lang='autoit'><br />
; Author Mhz<br />
; Forum <br />
Global $vKey, $sItem, $sMsg, $oDictionary <br />
<br />
; Create dictionary object<br />
$oDictionary = ObjCreate("Scripting.Dictionary")<br />
<br />
If @error Then<br />
MsgBox(0, '', 'Error creating the dictionary object')<br />
Else<br />
; Add keys with items<br />
$oDictionary.Add ("One", "Same" )<br />
$oDictionary.Add ("Two", "Car" )<br />
$oDictionary.Add ("Three", "House" )<br />
$oDictionary.Add ("Four", "Boat" )<br />
<br />
If $oDictionary.Exists('One') Then<br />
; Display item<br />
MsgBox(0x0, 'Item One', $oDictionary.Item('One'), 2)<br />
; Set an item<br />
$oDictionary.Item('One') = 'Changed'<br />
; Display item<br />
MsgBox(0x20, 'Did Item One Change?', $oDictionary.Item('One'), 3)<br />
; Remove key<br />
$oDictionary.Remove('One')<br />
; <br />
$oDictionary.Key ('Two') = 'Bike'<br />
EndIf<br />
<br />
Sleep(1000)<br />
<br />
; Store items into a variable<br />
For $vKey In $oDictionary<br />
$sItem &= $oDictionary.Item($vKey) & @CRLF<br />
Next<br />
<br />
; Display items<br />
MsgBox(0x0, 'Items Count: ' & $oDictionary.Count, $sItem, 3)<br />
<br />
; Add items into an array<br />
$aItems = $oDictionary.Items<br />
<br />
; Display items in the array<br />
For $i = 0 To $oDictionary.Count -1<br />
MsgBox(0x0, 'Items [ ' & $i & ' ]', $aItems[$i], 2)<br />
Next<br />
<br />
Sleep(1000)<br />
<br />
; Add keys into an array<br />
$aKeys = $oDictionary.Keys<br />
<br />
; Display keys in the array<br />
For $i = 0 To $oDictionary.Count -1<br />
MsgBox(0x0, 'Keys [ ' & $i & ' ]', $aKeys[$i], 2)<br />
Next<br />
EndIf<br />
</syntaxhighlight><br />
<br /><br />
<br /><br />
The original AutoIt Scripting Dictionary implementation appears to have been by Gary Frost as far back as 2007. It has since been modified to the following:<br />
<br /><br />
<syntaxhighlight lang='autoit'><br />
#cs<br />
Scripting Dictionary UDF<br />
<br />
Made by GaryFrost <https://www.autoitscript.com/forum/topic/47048-scripting-dictionary/><br />
Modified by Jefrey <jefrey[at]jefrey.ml><br />
<br />
Forum https://www.autoitscript.com/forum/topic/182334-scripting-dictionary-modified/<br />
<br />
#ce<br />
<br />
Func _InitDictionary()<br />
Return ObjCreate("Scripting.Dictionary")<br />
EndFunc ;==>_InitDictionary<br />
<br />
; Adds a key and item pair to a Dictionary object.<br />
Func _AddItem($oDictionary, $v_key, $v_item)<br />
$oDictionary.ADD($v_key, $v_item)<br />
If @error Then Return SetError(1, 1, -1)<br />
EndFunc ;==>_AddItem<br />
<br />
; Returns true if a specified key exists in the Dictionary object, false if it does not.<br />
Func _ItemExists($oDictionary, $v_key)<br />
Return $oDictionary.Exists($v_key)<br />
EndFunc ;==>_ItemExists<br />
<br />
; Returns an item for a specified key in a Dictionary object<br />
Func _Item($oDictionary, $v_key)<br />
Return $oDictionary.Item($v_key)<br />
EndFunc ;==>_Item<br />
<br />
; Sets an item for a specified key in a Dictionary object<br />
Func _ChangeItem($oDictionary, $v_key, $v_item)<br />
$oDictionary.Item($v_key) = $v_item<br />
EndFunc ;==>_ChangeItem<br />
<br />
; Sets a key in a Dictionary object.<br />
Func _ChangeKey($oDictionary, $v_key, $v_newKey)<br />
$oDictionary.Key($v_key) = $v_newKey<br />
EndFunc ;==>_ChangeKey<br />
<br />
; Removes a key, item pair from a Dictionary object.<br />
Func _ItemRemove($oDictionary, $v_key)<br />
$oDictionary.Remove($v_key)<br />
If @error Then Return SetError(1, 1, -1)<br />
EndFunc ;==>_ItemRemove<br />
<br />
; Returns the number of items in a collection or Dictionary object.<br />
Func _ItemCount($oDictionary)<br />
Return $oDictionary.Count<br />
EndFunc ;==>_ItemCount<br />
<br />
; Returns an array containing all the items in a Dictionary object<br />
Func _GetItems($oDictionary)<br />
Return $oDictionary.Items<br />
EndFunc ;==>_GetItems<br />
<br />
Func _Clear($oDictionary)<br />
Return $oDictionary.RemoveAll<br />
EndFunc<br />
<br />
</syntaxhighlight></div>Skysnakehttps://www.autoitscript.com/w/index.php?title=Associative_Arrays&diff=13713Associative Arrays2017-11-28T10:17:58Z<p>Skysnake: </p>
<hr />
<div>In computer science, an associative array, map, symbol table, or dictionary is an abstract data type composed of a collection of (key, value) pairs, such that each possible key appears at most once in the collection.<br />
An associative array differs from a “normal” array in one major way: rather than being indexed numerically (i.e. 0, 1, 2, 3, …), it is indexed by a key, or a language-like word. <br />
A Scripting.Dictionary is a standard object provided by the Microsoft ScripTing Runtime (scrrun.dll) dependency and is commonly used in VBScript, a reference to which needs to be added in order to create an object in your AutoIt project.<br />
<br /><br />
A dictionary object example by [https://www.autoitscript.com/forum/profile/2709-mhz/ MHz]<br />
<syntaxhighlight lang='autoit'><br />
Global $vKey, $sItem, $sMsg, $oDictionary <br />
<br />
; Create dictionary object<br />
$oDictionary = ObjCreate("Scripting.Dictionary")<br />
<br />
If @error Then<br />
MsgBox(0, '', 'Error creating the dictionary object')<br />
Else<br />
; Add keys with items<br />
$oDictionary.Add ("One", "Same" )<br />
$oDictionary.Add ("Two", "Car" )<br />
$oDictionary.Add ("Three", "House" )<br />
$oDictionary.Add ("Four", "Boat" )<br />
<br />
If $oDictionary.Exists('One') Then<br />
; Display item<br />
MsgBox(0x0, 'Item One', $oDictionary.Item('One'), 2)<br />
; Set an item<br />
$oDictionary.Item('One') = 'Changed'<br />
; Display item<br />
MsgBox(0x20, 'Did Item One Change?', $oDictionary.Item('One'), 3)<br />
; Remove key<br />
$oDictionary.Remove('One')<br />
; <br />
$oDictionary.Key ('Two') = 'Bike'<br />
EndIf<br />
<br />
Sleep(1000)<br />
<br />
; Store items into a variable<br />
For $vKey In $oDictionary<br />
$sItem &= $oDictionary.Item($vKey) & @CRLF<br />
Next<br />
<br />
; Display items<br />
MsgBox(0x0, 'Items Count: ' & $oDictionary.Count, $sItem, 3)<br />
<br />
; Add items into an array<br />
$aItems = $oDictionary.Items<br />
<br />
; Display items in the array<br />
For $i = 0 To $oDictionary.Count -1<br />
MsgBox(0x0, 'Items [ ' & $i & ' ]', $aItems[$i], 2)<br />
Next<br />
<br />
Sleep(1000)<br />
<br />
; Add keys into an array<br />
$aKeys = $oDictionary.Keys<br />
<br />
; Display keys in the array<br />
For $i = 0 To $oDictionary.Count -1<br />
MsgBox(0x0, 'Keys [ ' & $i & ' ]', $aKeys[$i], 2)<br />
Next<br />
EndIf<br />
</syntaxhighlight></div>Skysnakehttps://www.autoitscript.com/w/index.php?title=Associative_Arrays&diff=13712Associative Arrays2017-11-28T09:03:27Z<p>Skysnake: Created page with "In computer science, an associative array, map, symbol table, or dictionary is an abstract data type composed of a collection of (key, value) pairs, such that each possible ke..."</p>
<hr />
<div>In computer science, an associative array, map, symbol table, or dictionary is an abstract data type composed of a collection of (key, value) pairs, such that each possible key appears at most once in the collection.<br />
An associative array differs from a “normal” array in one major way: rather than being indexed numerically (i.e. 0, 1, 2, 3, …), it is indexed by a key, or a language-like word. <br />
A Scripting.Dictionary is a standard object provided by the Microsoft ScripTing Runtime (scrrun.dll) dependency and is commonly used in VBScript, a reference to which needs to be added in order to create an object in your AutoIt project.</div>Skysnakehttps://www.autoitscript.com/w/index.php?title=Arrays&diff=13711Arrays2017-11-28T08:58:26Z<p>Skysnake: </p>
<hr />
<div>An '''array''' is a [[Data_Structures|data structure]] which stores elements (variables) aligned in a computer's memory. Arrays are referenced by an [[identifier]] (variable name) and an index specifying a desired element. The array concept seems complex but the concept can be easily grasped. Why are arrays so important? The array is a fundamental data structure found in most programming languages. <br />
<br />
This tutorial targets people who are beginners. To understand how arrays work, it is imperative to try out and modify the provided samples. Make sure that each concept is understood before the next concept is attempted. This tutorial assumes the use of the SciTE editor. There is a minimal version of SciTE included in the latest stable release of AutoIt (version 3.2.0.1 and above).<br />
<br />
== Declaring Arrays in AutoIt ==<br />
<br />
An array is declared in the same manner as a variable in AutoIt. The difference is that for an array, extra information on how many elements are to be included in the array must be specified. This information is provided by adding brackets after the identifier and a number indicating how many elements the array will possess. <br />
<br />
<syntaxhighlight lang='autoit'><br />
Global $arr[4] ; Will make space for 4 elements.<br />
Local $arr[1] ; Will make space for 1 element.<br />
Dim $arr[3] ; Will make space for 3 elements. Note: Avoid using Dim. Use Global or Local instead.<br />
</syntaxhighlight> <br />
<br />
In AutoIt, a variable may be converted to an array by either using the {{Help File|ReDim}} keyword or assigning a function which returns an array to the variable. <br />
<br />
For example, the function {{Help File|StringSplit}} returns an array which will be assigned to $arr.<br />
<br />
<syntaxhighlight lang='autoit'><br />
Local $arr = StringSplit("This is my string. I want to split it in sentences.", '.')<br />
</syntaxhighlight><br />
<br />
Now to make really certain we have an array from {{Help File|StringSplit}}, we should check it with the {{Help File|IsArray}} built-in function.<br />
<br />
<syntaxhighlight lang='autoit'><br />
If IsArray($arr) Then <br />
; Do work on the array<br />
EndIf<br />
</syntaxhighlight><br />
<br />
== Assigning Data to Array Elements ==<br />
<br />
When we declare the array we make some room in memory for future data. We want to assign some data to the items in the array. Now here is the catch. The array always starts at index zero. So, the first element in the array will be accessed by zero, the second element in the array is accessed at by one and so on.<br />
<br />
<syntaxhighlight lang='autoit'><br />
Local $arr[3] ; Make room for three elements<br />
;Assign some data<br />
$arr[0] = "Element 1"<br />
$arr[1] = "Element 2"<br />
$arr[2] = "Element 3"<br />
</syntaxhighlight><br />
<br />
You can also assign all the data in one smack like this:<br />
<br />
<syntaxhighlight lang='autoit'><br />
Local $arr[3] = ["element 1", "element 2", "element 3"]<br />
</syntaxhighlight><br />
<br />
This zero-based indexing is quite common in most computer languages, but it can be a source of headaches to beginners until it becomes second nature to them. For example, every time you want to loop through a range of elements and the range includes the last element, you have to subtract one from the number of items your array is holding, to get the index of the last item. I.E., An array with three elements has a last index of two.<br />
<br />
So if you don't take zero-based indexing into consideration in your code, you may ask for something outside the memory area set aside for the array. When you do, you get an error message (<font color="red">Array variable has incorrect number of subscripts or subscript dimension range exceeded</font>) and your script will cease execution.<br />
<br />
== Accessing Data in Arrays ==<br />
<br />
Let's walk all elements in the previous sample:<br />
<br />
<syntaxhighlight lang='autoit'><br />
Local $arr[3] = ["element 1", "element 2", "element 3"] <br />
<br />
For $i = 0 to 3 - 1 ; We have an array with three elements but the last index is two.<br />
ConsoleWrite($arr[$i] & @LF)<br />
Next<br />
</syntaxhighlight><br />
<br />
=== Determine Array Size With UBound ===<br />
<br />
The "3 - 1" construct used in the last sample looked strange. It is not a good idea to hard-code size like that. So lets improve our sample a little. <br />
<br />
<syntaxhighlight lang='autoit'><br />
Local $iMax = 3<br />
<br />
Local $arr[$iMax] = ["Element 1", "Element 2", "Element 3"]<br />
<br />
For $i = 0 to $iMax - 1<br />
ConsoleWrite($arr[$i] & @LF)<br />
Next<br />
</syntaxhighlight><br />
<br />
Now that's a bit cleaner. It's also a lot easier to increase or decrease the size of the array. <br><br />
But say you don't know the size of the array upfront because it may come in a variable size when created dynamically.<br />
<br />
<syntaxhighlight lang='autoit'><br />
Local $iMax <br />
<br />
Local $data = "Element 1|Element 2|Element 3" <br />
<br />
; The string in data will be split into an array everywhere | is encountered <br />
Local $arr = StringSplit($data, "|") <br />
<br />
If IsArray($arr) Then<br />
$iMax = UBound($arr); get array size<br />
<br />
ConsoleWrite("Items in the array: " & $iMax & @LF)<br />
<br />
For $i = 0 to $iMax - 1; subtract 1 from size to prevent an out of bounds error<br />
ConsoleWrite($arr[$i] & @LF)<br />
Next<br />
EndIf<br />
</syntaxhighlight><br />
<br />
When you run the above code you will see that $iMax is four and not three as you might have expected. The reason for this is that the developer of the {{Help File|StringSplit}} function thought it was a good idea to use the first item (item zero) to keep a count of valid items in the array. This makes sense in many situations as you now have an array containing data with an index starting at one. So our sample code can now be rewritten like this.<br />
<br />
<syntaxhighlight lang='autoit'><br />
Local $iMax<br />
<br />
Local $data = "Element 1|Element 2|Element 3"<br />
<br />
; The string in data will be split into an array everywhere | is encountered<br />
Local $arr = StringSplit($data, "|") <br />
<br />
If IsArray($arr) Then <br />
For $i = 1 to $arr[0]<br />
ConsoleWrite($arr[$i] & @LF)<br />
Next<br />
EndIf<br />
</syntaxhighlight><br />
<br />
There is another good reason for keeping the count in $arr[0]. When you start to use arrays extensively, you will encounter situations where you have to create an array without knowing how many of the elements you will use. Resizing the array is a relatively expensive operation (in CPU cycles) in most languages.<br />
<br />
Now consider our example if our initial array has reserved space for ten items but we end up only using three. In this case iterating the array using {{Help File|UBound}} will force us to check for empty elements. While iterating with $arr[0] needs no other change than maintaining the correct count in $arr[0].<br />
<br />
<syntaxhighlight lang='autoit'><br />
Local $iMax=10<br />
<br />
;NOTE: We have added the count in the first element<br />
<br />
Local $arr[$iMax] = [3, "Element 1", "Element 2", "Element 3"]<br />
<br />
;NOTE: We use the count in $arr[0] to indicate the last item and we start from index=1<br />
For $i = 1 to $arr[0]<br />
ConsoleWrite($arr[$i] & @LF)<br />
Next<br />
</syntaxhighlight><br />
<br />
== Changing Array Sizes With ReDim ==<br />
<br />
As arrays are critical to algorithm implementations, and in AutoIt even more so as there is no other means of grouping data, we have to understand how to let it grow and shrink. This is where the keyword {{Help File|ReDim}} comes into the picture.<br />
<br />
Let's make an example. We want our array to hold data lines but we don't know how many items we need. We make a guess, in this case five. Now, we use that array to hold data we get from a loop with a random number of iterations. If the array is too small it should automatically be increased. Before we dump the array to output, we should adjust it to the exact size it is supposed to be.<br />
<br />
<syntaxhighlight lang="autoit"><br />
Local Const $iMax = 5<br />
<br />
; NOTE: We have added the count in the first element<br />
Local $arr[$iMax] = [0] ; Initiate the array and place a counter in the first element.<br />
<br />
; Generate a random number between 0 and 20<br />
Local Const $iRandom = Random(0, 20, 1)<br />
<br />
For $i = 1 to $iRandom<br />
; Check that the array is big enough<br />
If UBound($arr) = $i Then<br />
; Resize the array when $i is equal to the element count in the array to prevent subscript error<br />
ReDim $arr[$arr[0] + $iMax]<br />
EndIf<br />
<br />
$arr[$i] = "Item " & $i ; safely add data to new index element<br />
<br />
$arr[0] = $i ; update the index count for future reference<br />
Next<br />
<br />
; Adjust the array size. This time it is probably downward to the size of<br />
; $arr[0] + 1 (remember the first item is $arr[0])<br />
ReDim $arr[$arr[0] + 1] <br />
<br />
; Now dump the results<br />
For $i = 1 to $arr[0]<br />
ConsoleWrite("$arr[" & $i & "]:=" & $arr[$i] & @LF)<br />
Next<br />
<br />
; Visually check that the values are sound<br />
ConsoleWrite("Ubound($arr):=" & UBound($arr) & ", $arr[0]:=" & $arr[0] & ", $iRandom:=" & $iRandom & @LF)<br />
</syntaxhighlight><br />
<br />
Note how the array now has first been adjusted to a multiple of $iMax and in the last part adjusted down to a size matching the data items.<br />
<br />
== Passing Arrays to Functions ==<br />
<br />
There is no special syntax required to pass an array as a function argument unlike a low level language such as C.<br />
The following example demonstrates:<br />
<br />
<syntaxhighlight lang="AutoIt"><br />
Local Const $myArray[5] = [1, 2, 3, 4, 5]<br />
<br />
displayArray($myArray)<br />
<br />
Func displayArray(Const $array)<br />
Local Const $arrayLength = UBound($array)<br />
<br />
For $i = 0 To $arrayLength - 1<br />
MsgBox($MB_OK, "displayArray", $array[$i])<br />
Next<br />
EndFunc<br />
</syntaxhighlight><br />
<br />
You can not declare the variable to hold the array in the function declaration as an array. So, users could pass on a variable. So you have to check that the variable holds an array before you do array specific operations on it.<br />
The following code example will cause an error:<br />
<br />
<syntaxhighlight lang="AutoIt"><br />
Local Const $myArray[5] = [1, 2, 3, 4, 5]<br />
<br />
displayArray($myArray)<br />
<br />
Func displayArray(Const $array[5])<br />
Local Const $arrayLength = UBound($array)<br />
<br />
For $i = 0 To $arrayLength - 1<br />
MsgBox($MB_OK, "displayArray", $array[$i])<br />
Next<br />
EndFunc<br />
</syntaxhighlight><br />
<br />
During the tutorial you have probably noticed that there is a lot of code that is equal in each sample. I'm especially thinking about the code we have used to output the array content. Let's make life easier and create a debug function.<br />
<br />
<syntaxhighlight lang="autoit"><br />
Func dbgArray(ByRef $arr, $msg="")<br />
If $msg <> "" Then <br />
ConsoleWrite("*** " & $msg & " ***" & @LF)<br />
EndIf<br />
<br />
For $i = 0 to UBound($arr) - 1<br />
ConsoleWrite("$arr[" & $i & "]:=" & $arr[$i] & @LF)<br />
Next<br />
<br />
ConsoleWrite( "Ubound($arr)=:=" & UBound($arr) & ", $arr[0]:=" & $arr[0] & @LF) <br />
EndFunc <br />
</syntaxhighlight><br />
<br />
And let's make a little function to fill our arrays with something. Note how the ArrayFiller makes sure it works on an array.<br />
<br />
<syntaxhighlight lang="autoit"><br />
Func ArrayFiller(ByRef $arr)<br />
If IsArray($arr) Then <br />
ReDim $arr[3] ; Notice we might discard content in this operation<br />
Else<br />
Local $foo[3]<br />
$arr = $foo<br />
EndIf <br />
<br />
;Fill the array<br />
$arr[0] = 2<br />
$arr[1] = "Fill 1"<br />
$arr[2] = "Fill 2"<br />
EndFunc <br />
</syntaxhighlight><br />
<br />
And finally some code using the new functions<br />
<syntaxhighlight lang="autoit"><br />
Local $arr1[1]<br />
ArrayFiller($arr1)<br />
dbgArray($arr1)<br />
</syntaxhighlight><br />
<br />
This code is a test on what happens when we pass a regular variable.<br />
<syntaxhighlight lang="autoit"><br />
Local $arr2<br />
ArrayFiller($arr2)<br />
dbgArray($arr2)<br />
</syntaxhighlight><br />
<br />
== Returning Arrays From Functions ==<br />
<br />
As you could observe, in the previous samples, an array will be passed back and forth with the ByRef keyword infront of the variable holding the array in the function declaration.<br />
<br />
We could also have used the Return keyword in a function.<br />
Lets re-work the ArrayFiller function to do this rather than using a variable ByRef.<br />
<br />
<syntaxhighlight lang="autoit"><br />
Func ArrayFiller2()<br />
Local $arr = [3, "Fill 1", "Fill 2"]<br />
Return $arr<br />
EndFunc <br />
</syntaxhighlight><br />
<br />
And now we can use the function like this<br />
<br />
<syntaxhighlight lang="autoit"><br />
Local $foo = ArrayFiller2()<br />
dbgArray($foo)<br />
</syntaxhighlight><br />
<br />
== Comparing Arrays ==<br />
<br />
'''You can not compare complete arrays:'''<br/><br />
<syntaxhighlight lang="autoit"><br />
Local $Array1[3] = [1, 2, 3]<br />
Local $Array2[3] = [1, 2, 3]<br />
Local $Array3[4] = [1, 2, 3, 4]<br />
<br />
If $Array1 == $Array2 Then ConsoleWrite("1.) $Array1 is equal to $Array2! which might be correct in some sense." & @LF); while they contain the same data, the comparison does not work.<br />
<br />
If $Array1 == $Array3 Then ConsoleWrite("2.) $Array1 is equal to $Array3! which is incorrect." & @LF); even though they're different in size, it's incorrectly determined that they're equal.<br />
</syntaxhighlight><br />
<br />
I have the impression that such comparisons compare the memory address of the arrays instead of the array elements values. And the addresses are always different for different arrays. You have to instead, compare all elements one after the other. It might be a good idea to first compare array sizes if that can vary for both the compared arrays!<br />
<br />
The next example creates an array from user input and then compares elements from a 1D Array to the first column of a 2D array to return the matches as words.<br />
<syntaxhighlight lang="autoit"><br />
; sample number string split and convert to words<br />
; uncomment the ConsoleWrite and _ArrayDisplay lines to see what it does<br />
;# some includes<br />
#include <Array.au3><br />
<br />
;# some variables<br />
<br />
;Create 2D array to display<br />
Local $aWords[10][2] = [[0, 'nil'] _<br />
, [1, 'one'] _<br />
, [2, 'two'] _<br />
, [3, 'three'] _<br />
, [4, 'four'] _<br />
, [5, 'five'] _<br />
, [6, 'six'] _<br />
, [7, 'seven'] _<br />
, [8, 'eight'] _<br />
, [9, 'nine']] ; :)<br />
<br />
;~ _ArrayDisplay($aWords)<br />
<br />
; the order of the sample digits is to show that the comparison below is accurate, from left to right<br />
Local $Originalinput = InputBox("Type a number", "A number?","97524601")<br />
<br />
Local $userinput = $Originalinput ; pass the orginal input to a second var<br />
; now parse the userinput to that we know what was submitted, then repeat in words<br />
; first strip all white space<br />
$userinput = StringStripWS($userinput, 8)<br />
<br />
If StringIsDigit($userinput) Then ; continue<br />
<br />
; now get the length of the string<br />
Local $islong = StringLen($userinput)<br />
<br />
; make an array with size = length to insert items into<br />
Local $aInput[1] ; create blank one dimensional array<br />
;~ _ArrayDisplay($aInput)<br />
; eat the string one digit at a time :)<br />
Local $oneleft<br />
For $i = 1 To $islong Step 1<br />
$oneleft = StringLeft($userinput, 1)<br />
ConsoleWrite("$oneleft: " & $oneleft & @CRLF)<br />
$userinput = StringTrimLeft($userinput, 1) ; make the $userinput one shorter on each loop<br />
_ArrayAdd($aInput, $oneleft, 1)<br />
Next<br />
;~ _ArrayDisplay($aInput)<br />
; now write out what the user typed in words<br />
<br />
;~ ConsoleWrite("How long is the string: " & $islong & @CRLF)<br />
; compare the user input to our defined array<br />
For $k = 0 To $islong Step 1<br />
For $j = 0 To (UBound($aWords) - 1) Step 1<br />
;~ ConsoleWrite("Compare $j " & $aWords[$j][0] & " to $k " & $aInput[$k] & @CRLF)<br />
If $aWords[$j][0] == $aInput[$k] Then<br />
MsgBox(0, "Number to word", $Originalinput&@CRLF&"User typed "& $aInput[$k]& @CRLF & $aWords[$j][1] & @CRLF,1)<br />
EndIf<br />
;~ ConsoleWrite("For... Next inner loops: " & $k & @CRLF)<br />
Next<br />
;~ ConsoleWrite("For... Next outer loops: " & $j & @CRLF)<br />
Next<br />
<br />
EndIf ; if its not digits, skip<br />
<br />
</syntaxhighlight><br />
<br />
== Multi Dimensional Arrays ==<br />
<br />
Now what is a good explanation of a multi-dimensional array?<br />
It could be a table where you access one item in the table at a time.<br />
<br />
<syntaxhighlight lang="autoit"><br />
Local $arr[3][3] = [[1, 2, 3], [2, 3, 4], [3, 4, 5]]<br />
<br />
For $i = 0 to UBound( $arr, 1) - 1<br />
For $j = 0 to UBound($arr, 2) - 1<br />
ConsoleWrite("$arr[" & $i & "][" & $j & "]:=" & $arr[$i][$j] & @LF)<br />
Next <br />
<br />
ConsoleWrite(@LF)<br />
Next <br />
</syntaxhighlight><br />
<br />
You can add a number of dimensions not to exceed sixty-four as stated in the help file section [http://www.autoitscript.com/autoit3/docs/appendix/LimitsDefaults.htm AutoIt3 limits/Defaults].<br />
<br />
Here is a four dimensional example. You tell me how that initializer is for readability.<br />
<br />
<syntaxhighlight lang="autoit"> <br />
; NOTE: The following is supposed to be all on one line<br />
; but we use the "_" character to split it into multiple lines for readability<br />
<br />
Local $arr[3][3][3][3] = _<br />
[ _<br />
[ _<br />
[[1, 2, 3], [2, 3, 4], [3, 4, 5]], _<br />
[[1, 2, 3], [2, 3, 4], [3, 4, 5]], _<br />
[[1, 2, 3], [2, 3, 4], [3, 4, 5]] _<br />
], _<br />
[ _<br />
[[1, 2, 3], [2, 3, 4], [3, 4, 5]], _<br />
[[1, 2, 3], [2, 3, 4], [3, 4, 5]], _<br />
[[1, 2, 3], [2, 3, 4], [3, 4, 5]] _<br />
], _<br />
[ _<br />
[[1, 2, 3], [2, 3, 4], [3, 4, 5]], _<br />
[[1, 2, 3], [2, 3, 4], [3, 4, 5]], _<br />
[[1, 2, 3], [2, 3, 4], [3, 4, 5]] _<br />
] _<br />
]<br />
<br />
For $i = 0 To UBound($arr, 1) - 1<br />
For $j = 0 To UBound($arr, 2) - 1<br />
For $k = 0 To UBound($arr, 3) - 1<br />
For $l = 0 To UBound($arr, 4) - 1<br />
ConsoleWrite("$arr[" & $i & "][" & $j & "][" & $k & "][" & $l & "]:=" & $arr[$i][$j][$k][$l] & @LF)<br />
Next<br />
Next<br />
Next<br />
Next<br />
<br />
ConsoleWrite(@LF)<br />
</syntaxhighlight><br />
<br />
== Arrays in Arrays ==<br />
<br />
You may save an array in an array element (item). Remember that there may be issues if you pass an array containing arrays into a function and the embedded array is changed inside that function. So, as a general rule, try not to embed arrays within arrays unless you absolutely need to and are prepared to do rigorous testing to make sure your code will always work as expected.<br />
<br />
You can access the elements of these embedded arrays directly (note the additional () required):<br />
<br />
<syntaxhighlight lang="autoit"><br />
Local $aContainerArray[2]<br />
Local $aInternalArray_0[2] = ["Internal-0-0","Internal-0-1"]<br />
Local $aInternalArray_1[2] = ["Internal-1-0","Internal-1-1"]<br />
$aContainerArray[0] = $aInternalArray_0<br />
$aContainerArray[1] = $aInternalArray_1<br />
<br />
ConsoleWrite("1 element of InternalArray_0: " & ($aContainerArray[0])[1] & @CRLF)<br />
ConsoleWrite("0 element of InternalArray_1: " & ($aContainerArray[1])[0] & @CRLF)<br />
</syntaxhighlight><br />
<br />
== More Information ==<br />
<br />
AutoIt features a large list of [http://www.autoitscript.com/autoit3/docs/libfunctions.htm User Defined Functions (UDF)], among which is a module supplying extra array functions. You can find a reference on those functions in AutoIt's Help file as the last main chapter named [http://www.autoitscript.com/autoit3/docs/libfunctions.htm User Defined Functions Reference].<br />
[[Associative Arrays]]<br />
[[Category:Tutorials]]</div>Skysnakehttps://www.autoitscript.com/w/index.php?title=Arrays&diff=13710Arrays2017-11-28T08:56:35Z<p>Skysnake: </p>
<hr />
<div>An '''array''' is a [[Data_Structures|data structure]] which stores elements (variables) aligned in a computer's memory. Arrays are referenced by an [[identifier]] (variable name) and an index specifying a desired element. The array concept seems complex but the concept can be easily grasped. Why are arrays so important? The array is a fundamental data structure found in most programming languages. <br />
<br />
This tutorial targets people who are beginners. To understand how arrays work, it is imperative to try out and modify the provided samples. Make sure that each concept is understood before the next concept is attempted. This tutorial assumes the use of the SciTE editor. There is a minimal version of SciTE included in the latest stable release of AutoIt (version 3.2.0.1 and above).<br />
<br />
== Declaring Arrays in AutoIt ==<br />
<br />
An array is declared in the same manner as a variable in AutoIt. The difference is that for an array, extra information on how many elements are to be included in the array must be specified. This information is provided by adding brackets after the identifier and a number indicating how many elements the array will possess. <br />
<br />
<syntaxhighlight lang='autoit'><br />
Global $arr[4] ; Will make space for 4 elements.<br />
Local $arr[1] ; Will make space for 1 element.<br />
Dim $arr[3] ; Will make space for 3 elements. Note: Avoid using Dim. Use Global or Local instead.<br />
</syntaxhighlight> <br />
<br />
In AutoIt, a variable may be converted to an array by either using the {{Help File|ReDim}} keyword or assigning a function which returns an array to the variable. <br />
<br />
For example, the function {{Help File|StringSplit}} returns an array which will be assigned to $arr.<br />
<br />
<syntaxhighlight lang='autoit'><br />
Local $arr = StringSplit("This is my string. I want to split it in sentences.", '.')<br />
</syntaxhighlight><br />
<br />
Now to make really certain we have an array from {{Help File|StringSplit}}, we should check it with the {{Help File|IsArray}} built-in function.<br />
<br />
<syntaxhighlight lang='autoit'><br />
If IsArray($arr) Then <br />
; Do work on the array<br />
EndIf<br />
</syntaxhighlight><br />
<br />
== Assigning Data to Array Elements ==<br />
<br />
When we declare the array we make some room in memory for future data. We want to assign some data to the items in the array. Now here is the catch. The array always starts at index zero. So, the first element in the array will be accessed by zero, the second element in the array is accessed at by one and so on.<br />
<br />
<syntaxhighlight lang='autoit'><br />
Local $arr[3] ; Make room for three elements<br />
;Assign some data<br />
$arr[0] = "Element 1"<br />
$arr[1] = "Element 2"<br />
$arr[2] = "Element 3"<br />
</syntaxhighlight><br />
<br />
You can also assign all the data in one smack like this:<br />
<br />
<syntaxhighlight lang='autoit'><br />
Local $arr[3] = ["element 1", "element 2", "element 3"]<br />
</syntaxhighlight><br />
<br />
This zero-based indexing is quite common in most computer languages, but it can be a source of headaches to beginners until it becomes second nature to them. For example, every time you want to loop through a range of elements and the range includes the last element, you have to subtract one from the number of items your array is holding, to get the index of the last item. I.E., An array with three elements has a last index of two.<br />
<br />
So if you don't take zero-based indexing into consideration in your code, you may ask for something outside the memory area set aside for the array. When you do, you get an error message (<font color="red">Array variable has incorrect number of subscripts or subscript dimension range exceeded</font>) and your script will cease execution.<br />
<br />
== Accessing Data in Arrays ==<br />
<br />
Let's walk all elements in the previous sample:<br />
<br />
<syntaxhighlight lang='autoit'><br />
Local $arr[3] = ["element 1", "element 2", "element 3"] <br />
<br />
For $i = 0 to 3 - 1 ; We have an array with three elements but the last index is two.<br />
ConsoleWrite($arr[$i] & @LF)<br />
Next<br />
</syntaxhighlight><br />
<br />
=== Determine Array Size With UBound ===<br />
<br />
The "3 - 1" construct used in the last sample looked strange. It is not a good idea to hard-code size like that. So lets improve our sample a little. <br />
<br />
<syntaxhighlight lang='autoit'><br />
Local $iMax = 3<br />
<br />
Local $arr[$iMax] = ["Element 1", "Element 2", "Element 3"]<br />
<br />
For $i = 0 to $iMax - 1<br />
ConsoleWrite($arr[$i] & @LF)<br />
Next<br />
</syntaxhighlight><br />
<br />
Now that's a bit cleaner. It's also a lot easier to increase or decrease the size of the array. <br><br />
But say you don't know the size of the array upfront because it may come in a variable size when created dynamically.<br />
<br />
<syntaxhighlight lang='autoit'><br />
Local $iMax <br />
<br />
Local $data = "Element 1|Element 2|Element 3" <br />
<br />
; The string in data will be split into an array everywhere | is encountered <br />
Local $arr = StringSplit($data, "|") <br />
<br />
If IsArray($arr) Then<br />
$iMax = UBound($arr); get array size<br />
<br />
ConsoleWrite("Items in the array: " & $iMax & @LF)<br />
<br />
For $i = 0 to $iMax - 1; subtract 1 from size to prevent an out of bounds error<br />
ConsoleWrite($arr[$i] & @LF)<br />
Next<br />
EndIf<br />
</syntaxhighlight><br />
<br />
When you run the above code you will see that $iMax is four and not three as you might have expected. The reason for this is that the developer of the {{Help File|StringSplit}} function thought it was a good idea to use the first item (item zero) to keep a count of valid items in the array. This makes sense in many situations as you now have an array containing data with an index starting at one. So our sample code can now be rewritten like this.<br />
<br />
<syntaxhighlight lang='autoit'><br />
Local $iMax<br />
<br />
Local $data = "Element 1|Element 2|Element 3"<br />
<br />
; The string in data will be split into an array everywhere | is encountered<br />
Local $arr = StringSplit($data, "|") <br />
<br />
If IsArray($arr) Then <br />
For $i = 1 to $arr[0]<br />
ConsoleWrite($arr[$i] & @LF)<br />
Next<br />
EndIf<br />
</syntaxhighlight><br />
<br />
There is another good reason for keeping the count in $arr[0]. When you start to use arrays extensively, you will encounter situations where you have to create an array without knowing how many of the elements you will use. Resizing the array is a relatively expensive operation (in CPU cycles) in most languages.<br />
<br />
Now consider our example if our initial array has reserved space for ten items but we end up only using three. In this case iterating the array using {{Help File|UBound}} will force us to check for empty elements. While iterating with $arr[0] needs no other change than maintaining the correct count in $arr[0].<br />
<br />
<syntaxhighlight lang='autoit'><br />
Local $iMax=10<br />
<br />
;NOTE: We have added the count in the first element<br />
<br />
Local $arr[$iMax] = [3, "Element 1", "Element 2", "Element 3"]<br />
<br />
;NOTE: We use the count in $arr[0] to indicate the last item and we start from index=1<br />
For $i = 1 to $arr[0]<br />
ConsoleWrite($arr[$i] & @LF)<br />
Next<br />
</syntaxhighlight><br />
<br />
== Changing Array Sizes With ReDim ==<br />
<br />
As arrays are critical to algorithm implementations, and in AutoIt even more so as there is no other means of grouping data, we have to understand how to let it grow and shrink. This is where the keyword {{Help File|ReDim}} comes into the picture.<br />
<br />
Let's make an example. We want our array to hold data lines but we don't know how many items we need. We make a guess, in this case five. Now, we use that array to hold data we get from a loop with a random number of iterations. If the array is too small it should automatically be increased. Before we dump the array to output, we should adjust it to the exact size it is supposed to be.<br />
<br />
<syntaxhighlight lang="autoit"><br />
Local Const $iMax = 5<br />
<br />
; NOTE: We have added the count in the first element<br />
Local $arr[$iMax] = [0] ; Initiate the array and place a counter in the first element.<br />
<br />
; Generate a random number between 0 and 20<br />
Local Const $iRandom = Random(0, 20, 1)<br />
<br />
For $i = 1 to $iRandom<br />
; Check that the array is big enough<br />
If UBound($arr) = $i Then<br />
; Resize the array when $i is equal to the element count in the array to prevent subscript error<br />
ReDim $arr[$arr[0] + $iMax]<br />
EndIf<br />
<br />
$arr[$i] = "Item " & $i ; safely add data to new index element<br />
<br />
$arr[0] = $i ; update the index count for future reference<br />
Next<br />
<br />
; Adjust the array size. This time it is probably downward to the size of<br />
; $arr[0] + 1 (remember the first item is $arr[0])<br />
ReDim $arr[$arr[0] + 1] <br />
<br />
; Now dump the results<br />
For $i = 1 to $arr[0]<br />
ConsoleWrite("$arr[" & $i & "]:=" & $arr[$i] & @LF)<br />
Next<br />
<br />
; Visually check that the values are sound<br />
ConsoleWrite("Ubound($arr):=" & UBound($arr) & ", $arr[0]:=" & $arr[0] & ", $iRandom:=" & $iRandom & @LF)<br />
</syntaxhighlight><br />
<br />
Note how the array now has first been adjusted to a multiple of $iMax and in the last part adjusted down to a size matching the data items.<br />
<br />
== Passing Arrays to Functions ==<br />
<br />
There is no special syntax required to pass an array as a function argument unlike a low level language such as C.<br />
The following example demonstrates:<br />
<br />
<syntaxhighlight lang="AutoIt"><br />
Local Const $myArray[5] = [1, 2, 3, 4, 5]<br />
<br />
displayArray($myArray)<br />
<br />
Func displayArray(Const $array)<br />
Local Const $arrayLength = UBound($array)<br />
<br />
For $i = 0 To $arrayLength - 1<br />
MsgBox($MB_OK, "displayArray", $array[$i])<br />
Next<br />
EndFunc<br />
</syntaxhighlight><br />
<br />
You can not declare the variable to hold the array in the function declaration as an array. So, users could pass on a variable. So you have to check that the variable holds an array before you do array specific operations on it.<br />
The following code example will cause an error:<br />
<br />
<syntaxhighlight lang="AutoIt"><br />
Local Const $myArray[5] = [1, 2, 3, 4, 5]<br />
<br />
displayArray($myArray)<br />
<br />
Func displayArray(Const $array[5])<br />
Local Const $arrayLength = UBound($array)<br />
<br />
For $i = 0 To $arrayLength - 1<br />
MsgBox($MB_OK, "displayArray", $array[$i])<br />
Next<br />
EndFunc<br />
</syntaxhighlight><br />
<br />
During the tutorial you have probably noticed that there is a lot of code that is equal in each sample. I'm especially thinking about the code we have used to output the array content. Let's make life easier and create a debug function.<br />
<br />
<syntaxhighlight lang="autoit"><br />
Func dbgArray(ByRef $arr, $msg="")<br />
If $msg <> "" Then <br />
ConsoleWrite("*** " & $msg & " ***" & @LF)<br />
EndIf<br />
<br />
For $i = 0 to UBound($arr) - 1<br />
ConsoleWrite("$arr[" & $i & "]:=" & $arr[$i] & @LF)<br />
Next<br />
<br />
ConsoleWrite( "Ubound($arr)=:=" & UBound($arr) & ", $arr[0]:=" & $arr[0] & @LF) <br />
EndFunc <br />
</syntaxhighlight><br />
<br />
And let's make a little function to fill our arrays with something. Note how the ArrayFiller makes sure it works on an array.<br />
<br />
<syntaxhighlight lang="autoit"><br />
Func ArrayFiller(ByRef $arr)<br />
If IsArray($arr) Then <br />
ReDim $arr[3] ; Notice we might discard content in this operation<br />
Else<br />
Local $foo[3]<br />
$arr = $foo<br />
EndIf <br />
<br />
;Fill the array<br />
$arr[0] = 2<br />
$arr[1] = "Fill 1"<br />
$arr[2] = "Fill 2"<br />
EndFunc <br />
</syntaxhighlight><br />
<br />
And finally some code using the new functions<br />
<syntaxhighlight lang="autoit"><br />
Local $arr1[1]<br />
ArrayFiller($arr1)<br />
dbgArray($arr1)<br />
</syntaxhighlight><br />
<br />
This code is a test on what happens when we pass a regular variable.<br />
<syntaxhighlight lang="autoit"><br />
Local $arr2<br />
ArrayFiller($arr2)<br />
dbgArray($arr2)<br />
</syntaxhighlight><br />
<br />
== Returning Arrays From Functions ==<br />
<br />
As you could observe, in the previous samples, an array will be passed back and forth with the ByRef keyword infront of the variable holding the array in the function declaration.<br />
<br />
We could also have used the Return keyword in a function.<br />
Lets re-work the ArrayFiller function to do this rather than using a variable ByRef.<br />
<br />
<syntaxhighlight lang="autoit"><br />
Func ArrayFiller2()<br />
Local $arr = [3, "Fill 1", "Fill 2"]<br />
Return $arr<br />
EndFunc <br />
</syntaxhighlight><br />
<br />
And now we can use the function like this<br />
<br />
<syntaxhighlight lang="autoit"><br />
Local $foo = ArrayFiller2()<br />
dbgArray($foo)<br />
</syntaxhighlight><br />
<br />
== Comparing Arrays ==<br />
<br />
'''You can not compare complete arrays:'''<br/><br />
<syntaxhighlight lang="autoit"><br />
Local $Array1[3] = [1, 2, 3]<br />
Local $Array2[3] = [1, 2, 3]<br />
Local $Array3[4] = [1, 2, 3, 4]<br />
<br />
If $Array1 == $Array2 Then ConsoleWrite("1.) $Array1 is equal to $Array2! which might be correct in some sense." & @LF); while they contain the same data, the comparison does not work.<br />
<br />
If $Array1 == $Array3 Then ConsoleWrite("2.) $Array1 is equal to $Array3! which is incorrect." & @LF); even though they're different in size, it's incorrectly determined that they're equal.<br />
</syntaxhighlight><br />
<br />
I have the impression that such comparisons compare the memory address of the arrays instead of the array elements values. And the addresses are always different for different arrays. You have to instead, compare all elements one after the other. It might be a good idea to first compare array sizes if that can vary for both the compared arrays!<br />
<br />
The next example creates an array from user input and then compares elements from a 1D Array to the first column of a 2D array to return the matches as words.<br />
<syntaxhighlight lang="autoit"><br />
; sample number string split and convert to words<br />
; uncomment the ConsoleWrite and _ArrayDisplay lines to see what it does<br />
;# some includes<br />
#include <Array.au3><br />
<br />
;# some variables<br />
<br />
;Create 2D array to display<br />
Local $aWords[10][2] = [[0, 'nil'] _<br />
, [1, 'one'] _<br />
, [2, 'two'] _<br />
, [3, 'three'] _<br />
, [4, 'four'] _<br />
, [5, 'five'] _<br />
, [6, 'six'] _<br />
, [7, 'seven'] _<br />
, [8, 'eight'] _<br />
, [9, 'nine']] ; :)<br />
<br />
;~ _ArrayDisplay($aWords)<br />
<br />
; the order of the sample digits is to show that the comparison below is accurate, from left to right<br />
Local $Originalinput = InputBox("Type a number", "A number?","97524601")<br />
<br />
Local $userinput = $Originalinput ; pass the orginal input to a second var<br />
; now parse the userinput to that we know what was submitted, then repeat in words<br />
; first strip all white space<br />
$userinput = StringStripWS($userinput, 8)<br />
<br />
If StringIsDigit($userinput) Then ; continue<br />
<br />
; now get the length of the string<br />
Local $islong = StringLen($userinput)<br />
<br />
; make an array with size = length to insert items into<br />
Local $aInput[1] ; create blank one dimensional array<br />
;~ _ArrayDisplay($aInput)<br />
; eat the string one digit at a time :)<br />
Local $oneleft<br />
For $i = 1 To $islong Step 1<br />
$oneleft = StringLeft($userinput, 1)<br />
ConsoleWrite("$oneleft: " & $oneleft & @CRLF)<br />
$userinput = StringTrimLeft($userinput, 1) ; make the $userinput one shorter on each loop<br />
_ArrayAdd($aInput, $oneleft, 1)<br />
Next<br />
;~ _ArrayDisplay($aInput)<br />
; now write out what the user typed in words<br />
<br />
;~ ConsoleWrite("How long is the string: " & $islong & @CRLF)<br />
; compare the user input to our defined array<br />
For $k = 0 To $islong Step 1<br />
For $j = 0 To (UBound($aWords) - 1) Step 1<br />
;~ ConsoleWrite("Compare $j " & $aWords[$j][0] & " to $k " & $aInput[$k] & @CRLF)<br />
If $aWords[$j][0] == $aInput[$k] Then<br />
MsgBox(0, "Number to word", $Originalinput&@CRLF&"User typed "& $aInput[$k]& @CRLF & $aWords[$j][1] & @CRLF,1)<br />
EndIf<br />
;~ ConsoleWrite("For... Next inner loops: " & $k & @CRLF)<br />
Next<br />
;~ ConsoleWrite("For... Next outer loops: " & $j & @CRLF)<br />
Next<br />
<br />
EndIf ; if its not digits, skip<br />
<br />
</syntaxhighlight><br />
<br />
== Multi Dimensional Arrays ==<br />
<br />
Now what is a good explanation of a multi-dimensional array?<br />
It could be a table where you access one item in the table at a time.<br />
<br />
<syntaxhighlight lang="autoit"><br />
Local $arr[3][3] = [[1, 2, 3], [2, 3, 4], [3, 4, 5]]<br />
<br />
For $i = 0 to UBound( $arr, 1) - 1<br />
For $j = 0 to UBound($arr, 2) - 1<br />
ConsoleWrite("$arr[" & $i & "][" & $j & "]:=" & $arr[$i][$j] & @LF)<br />
Next <br />
<br />
ConsoleWrite(@LF)<br />
Next <br />
</syntaxhighlight><br />
<br />
You can add a number of dimensions not to exceed sixty-four as stated in the help file section [http://www.autoitscript.com/autoit3/docs/appendix/LimitsDefaults.htm AutoIt3 limits/Defaults].<br />
<br />
Here is a four dimensional example. You tell me how that initializer is for readability.<br />
<br />
<syntaxhighlight lang="autoit"> <br />
; NOTE: The following is supposed to be all on one line<br />
; but we use the "_" character to split it into multiple lines for readability<br />
<br />
Local $arr[3][3][3][3] = _<br />
[ _<br />
[ _<br />
[[1, 2, 3], [2, 3, 4], [3, 4, 5]], _<br />
[[1, 2, 3], [2, 3, 4], [3, 4, 5]], _<br />
[[1, 2, 3], [2, 3, 4], [3, 4, 5]] _<br />
], _<br />
[ _<br />
[[1, 2, 3], [2, 3, 4], [3, 4, 5]], _<br />
[[1, 2, 3], [2, 3, 4], [3, 4, 5]], _<br />
[[1, 2, 3], [2, 3, 4], [3, 4, 5]] _<br />
], _<br />
[ _<br />
[[1, 2, 3], [2, 3, 4], [3, 4, 5]], _<br />
[[1, 2, 3], [2, 3, 4], [3, 4, 5]], _<br />
[[1, 2, 3], [2, 3, 4], [3, 4, 5]] _<br />
] _<br />
]<br />
<br />
For $i = 0 To UBound($arr, 1) - 1<br />
For $j = 0 To UBound($arr, 2) - 1<br />
For $k = 0 To UBound($arr, 3) - 1<br />
For $l = 0 To UBound($arr, 4) - 1<br />
ConsoleWrite("$arr[" & $i & "][" & $j & "][" & $k & "][" & $l & "]:=" & $arr[$i][$j][$k][$l] & @LF)<br />
Next<br />
Next<br />
Next<br />
Next<br />
<br />
ConsoleWrite(@LF)<br />
</syntaxhighlight><br />
<br />
== Arrays in Arrays ==<br />
<br />
You may save an array in an array element (item). Remember that there may be issues if you pass an array containing arrays into a function and the embedded array is changed inside that function. So, as a general rule, try not to embed arrays within arrays unless you absolutely need to and are prepared to do rigorous testing to make sure your code will always work as expected.<br />
<br />
You can access the elements of these embedded arrays directly (note the additional () required):<br />
<br />
<syntaxhighlight lang="autoit"><br />
Local $aContainerArray[2]<br />
Local $aInternalArray_0[2] = ["Internal-0-0","Internal-0-1"]<br />
Local $aInternalArray_1[2] = ["Internal-1-0","Internal-1-1"]<br />
$aContainerArray[0] = $aInternalArray_0<br />
$aContainerArray[1] = $aInternalArray_1<br />
<br />
ConsoleWrite("1 element of InternalArray_0: " & ($aContainerArray[0])[1] & @CRLF)<br />
ConsoleWrite("0 element of InternalArray_1: " & ($aContainerArray[1])[0] & @CRLF)<br />
</syntaxhighlight><br />
<br />
== More Information ==<br />
<br />
AutoIt features a large list of [http://www.autoitscript.com/autoit3/docs/libfunctions.htm User Defined Functions (UDF)], among which is a module supplying extra array functions. You can find a reference on those functions in AutoIt's Help file as the last main chapter named [http://www.autoitscript.com/autoit3/docs/libfunctions.htm User Defined Functions Reference].<br />
[http://www.autoitscript.com/autoit3/docs/assocarray.htm Associative Arrays]<br />
[[Category:Tutorials]]</div>Skysnakehttps://www.autoitscript.com/w/index.php?title=Arrays&diff=13672Arrays2017-08-30T14:47:15Z<p>Skysnake: /* Comparing Arrays */</p>
<hr />
<div>An '''array''' is a [[Data_Structures|data structure]] which stores elements (variables) aligned in a computer's memory. Arrays are referenced by an [[identifier]] (variable name) and an index specifying a desired element. The array concept seems complex but the concept can be easily grasped. Why are arrays so important? The array is a fundamental data structure found in most programming languages. <br />
<br />
This tutorial targets people who are beginners. To understand how arrays work, it is imperative to try out and modify the provided samples. Make sure that each concept is understood before the next concept is attempted. This tutorial assumes the use of the SciTE editor. There is a minimal version of SciTE included in the latest stable release of AutoIt (version 3.2.0.1 and above).<br />
<br />
== Declaring Arrays in AutoIt ==<br />
<br />
An array is declared in the same manner as a variable in AutoIt. The difference is that for an array, extra information on how many elements are to be included in the array must be specified. This information is provided by adding brackets after the identifier and a number indicating how many elements the array will possess. <br />
<br />
<syntaxhighlight lang='autoit'><br />
Global $arr[4] ; Will make space for 4 elements.<br />
Local $arr[1] ; Will make space for 1 element.<br />
Dim $arr[3] ; Will make space for 3 elements. Note: Avoid using Dim. Use Global or Local instead.<br />
</syntaxhighlight> <br />
<br />
In AutoIt, a variable may be converted to an array by either using the {{Help File|ReDim}} keyword or assigning a function which returns an array to the variable. <br />
<br />
For example, the function {{Help File|StringSplit}} returns an array which will be assigned to $arr.<br />
<br />
<syntaxhighlight lang='autoit'><br />
Local $arr = StringSplit("This is my string. I want to split it in sentences.", '.')<br />
</syntaxhighlight><br />
<br />
Now to make really certain we have an array from {{Help File|StringSplit}}, we should check it with the {{Help File|IsArray}} built-in function.<br />
<br />
<syntaxhighlight lang='autoit'><br />
If IsArray($arr) Then <br />
; Do work on the array<br />
EndIf<br />
</syntaxhighlight><br />
<br />
== Assigning Data to Array Elements ==<br />
<br />
When we declare the array we make some room in memory for future data. We want to assign some data to the items in the array. Now here is the catch. The array always starts at index zero. So, the first element in the array will be accessed by zero, the second element in the array is accessed at by one and so on.<br />
<br />
<syntaxhighlight lang='autoit'><br />
Local $arr[3] ; Make room for three elements<br />
;Assign some data<br />
$arr[0] = "Element 1"<br />
$arr[1] = "Element 2"<br />
$arr[2] = "Element 3"<br />
</syntaxhighlight><br />
<br />
You can also assign all the data in one smack like this:<br />
<br />
<syntaxhighlight lang='autoit'><br />
Local $arr[3] = ["element 1", "element 2", "element 3"]<br />
</syntaxhighlight><br />
<br />
This zero-based indexing is quite common in most computer languages, but it can be a source of headaches to beginners until it becomes second nature to them. For example, every time you want to loop through a range of elements and the range includes the last element, you have to subtract one from the number of items your array is holding, to get the index of the last item. I.E., An array with three elements has a last index of two.<br />
<br />
So if you don't take zero-based indexing into consideration in your code, you may ask for something outside the memory area set aside for the array. When you do, you get an error message (<font color="red">Array variable has incorrect number of subscripts or subscript dimension range exceeded</font>) and your script will cease execution.<br />
<br />
== Accessing Data in Arrays ==<br />
<br />
Let's walk all elements in the previous sample:<br />
<br />
<syntaxhighlight lang='autoit'><br />
Local $arr[3] = ["element 1", "element 2", "element 3"] <br />
<br />
For $i = 0 to 3 - 1 ; We have an array with three elements but the last index is two.<br />
ConsoleWrite($arr[$i] & @LF)<br />
Next<br />
</syntaxhighlight><br />
<br />
=== Determine Array Size With UBound ===<br />
<br />
The "3 - 1" construct used in the last sample looked strange. It is not a good idea to hard-code size like that. So lets improve our sample a little. <br />
<br />
<syntaxhighlight lang='autoit'><br />
Local $iMax = 3<br />
<br />
Local $arr[$iMax] = ["Element 1", "Element 2", "Element 3"]<br />
<br />
For $i = 0 to $iMax - 1<br />
ConsoleWrite($arr[$i] & @LF)<br />
Next<br />
</syntaxhighlight><br />
<br />
Now that's a bit cleaner. It's also a lot easier to increase or decrease the size of the array. <br><br />
But say you don't know the size of the array upfront because it may come in a variable size when created dynamically.<br />
<br />
<syntaxhighlight lang='autoit'><br />
Local $iMax <br />
<br />
Local $data = "Element 1|Element 2|Element 3" <br />
<br />
; The string in data will be split into an array everywhere | is encountered <br />
Local $arr = StringSplit($data, "|") <br />
<br />
If IsArray($arr) Then<br />
$iMax = UBound($arr); get array size<br />
<br />
ConsoleWrite("Items in the array: " & $iMax & @LF)<br />
<br />
For $i = 0 to $iMax - 1; subtract 1 from size to prevent an out of bounds error<br />
ConsoleWrite($arr[$i] & @LF)<br />
Next<br />
EndIf<br />
</syntaxhighlight><br />
<br />
When you run the above code you will see that $iMax is four and not three as you might have expected. The reason for this is that the developer of the {{Help File|StringSplit}} function thought it was a good idea to use the first item (item zero) to keep a count of valid items in the array. This makes sense in many situations as you now have an array containing data with an index starting at one. So our sample code can now be rewritten like this.<br />
<br />
<syntaxhighlight lang='autoit'><br />
Local $iMax<br />
<br />
Local $data = "Element 1|Element 2|Element 3"<br />
<br />
; The string in data will be split into an array everywhere | is encountered<br />
Local $arr = StringSplit($data, "|") <br />
<br />
If IsArray($arr) Then <br />
For $i = 1 to $arr[0]<br />
ConsoleWrite($arr[$i] & @LF)<br />
Next<br />
EndIf<br />
</syntaxhighlight><br />
<br />
There is another good reason for keeping the count in $arr[0]. When you start to use arrays extensively, you will encounter situations where you have to create an array without knowing how many of the elements you will use. Resizing the array is a relatively expensive operation (in CPU cycles) in most languages.<br />
<br />
Now consider our example if our initial array has reserved space for ten items but we end up only using three. In this case iterating the array using {{Help File|UBound}} will force us to check for empty elements. While iterating with $arr[0] needs no other change than maintaining the correct count in $arr[0].<br />
<br />
<syntaxhighlight lang='autoit'><br />
Local $iMax=10<br />
<br />
;NOTE: We have added the count in the first element<br />
<br />
Local $arr[$iMax] = [3, "Element 1", "Element 2", "Element 3"]<br />
<br />
;NOTE: We use the count in $arr[0] to indicate the last item and we start from index=1<br />
For $i = 1 to $arr[0]<br />
ConsoleWrite($arr[$i] & @LF)<br />
Next<br />
</syntaxhighlight><br />
<br />
== Changing Array Sizes With ReDim ==<br />
<br />
As arrays are critical to algorithm implementations, and in AutoIt even more so as there is no other means of grouping data, we have to understand how to let it grow and shrink. This is where the keyword {{Help File|ReDim}} comes into the picture.<br />
<br />
Let's make an example. We want our array to hold data lines but we don't know how many items we need. We make a guess, in this case five. Now, we use that array to hold data we get from a loop with a random number of iterations. If the array is too small it should automatically be increased. Before we dump the array to output, we should adjust it to the exact size it is supposed to be.<br />
<br />
<syntaxhighlight lang="autoit"><br />
Local Const $iMax = 5<br />
<br />
; NOTE: We have added the count in the first element<br />
Local $arr[$iMax] = [0] ; Initiate the array and place a counter in the first element.<br />
<br />
; Generate a random number between 0 and 20<br />
Local Const $iRandom = Random(0, 20, 1)<br />
<br />
For $i = 1 to $iRandom<br />
; Check that the array is big enough<br />
If UBound($arr) = $i Then<br />
; Resize the array when $i is equal to the element count in the array to prevent subscript error<br />
ReDim $arr[$arr[0] + $iMax]<br />
EndIf<br />
<br />
$arr[$i] = "Item " & $i ; safely add data to new index element<br />
<br />
$arr[0] = $i ; update the index count for future reference<br />
Next<br />
<br />
; Adjust the array size. This time it is probably downward to the size of<br />
; $arr[0] + 1 (remember the first item is $arr[0])<br />
ReDim $arr[$arr[0] + 1] <br />
<br />
; Now dump the results<br />
For $i = 1 to $arr[0]<br />
ConsoleWrite("$arr[" & $i & "]:=" & $arr[$i] & @LF)<br />
Next<br />
<br />
; Visually check that the values are sound<br />
ConsoleWrite("Ubound($arr):=" & UBound($arr) & ", $arr[0]:=" & $arr[0] & ", $iRandom:=" & $iRandom & @LF)<br />
</syntaxhighlight><br />
<br />
Note how the array now has first been adjusted to a multiple of $iMax and in the last part adjusted down to a size matching the data items.<br />
<br />
== Passing Arrays to Functions ==<br />
<br />
There is no special syntax required to pass an array as a function argument unlike a low level language such as C.<br />
The following example demonstrates:<br />
<br />
<syntaxhighlight lang="AutoIt"><br />
Local Const $myArray[5] = [1, 2, 3, 4, 5]<br />
<br />
displayArray($myArray)<br />
<br />
Func displayArray(Const $array)<br />
Local Const $arrayLength = UBound($array)<br />
<br />
For $i = 0 To $arrayLength - 1<br />
MsgBox($MB_OK, "displayArray", $array[$i])<br />
Next<br />
EndFunc<br />
</syntaxhighlight><br />
<br />
You can not declare the variable to hold the array in the function declaration as an array. So, users could pass on a variable. So you have to check that the variable holds an array before you do array specific operations on it.<br />
The following code example will cause an error:<br />
<br />
<syntaxhighlight lang="AutoIt"><br />
Local Const $myArray[5] = [1, 2, 3, 4, 5]<br />
<br />
displayArray($myArray)<br />
<br />
Func displayArray(Const $array[5])<br />
Local Const $arrayLength = UBound($array)<br />
<br />
For $i = 0 To $arrayLength - 1<br />
MsgBox($MB_OK, "displayArray", $array[$i])<br />
Next<br />
EndFunc<br />
</syntaxhighlight><br />
<br />
During the tutorial you have probably noticed that there is a lot of code that is equal in each sample. I'm especially thinking about the code we have used to output the array content. Let's make life easier and create a debug function.<br />
<br />
<syntaxhighlight lang="autoit"><br />
Func dbgArray(ByRef $arr, $msg="")<br />
If $msg <> "" Then <br />
ConsoleWrite("*** " & $msg & " ***" & @LF)<br />
EndIf<br />
<br />
For $i = 0 to UBound($arr) - 1<br />
ConsoleWrite("$arr[" & $i & "]:=" & $arr[$i] & @LF)<br />
Next<br />
<br />
ConsoleWrite( "Ubound($arr)=:=" & UBound($arr) & ", $arr[0]:=" & $arr[0] & @LF) <br />
EndFunc <br />
</syntaxhighlight><br />
<br />
And let's make a little function to fill our arrays with something. Note how the ArrayFiller makes sure it works on an array.<br />
<br />
<syntaxhighlight lang="autoit"><br />
Func ArrayFiller(ByRef $arr)<br />
If IsArray($arr) Then <br />
ReDim $arr[3] ; Notice we might discard content in this operation<br />
Else<br />
Local $foo[3]<br />
$arr = $foo<br />
EndIf <br />
<br />
;Fill the array<br />
$arr[0] = 2<br />
$arr[1] = "Fill 1"<br />
$arr[2] = "Fill 2"<br />
EndFunc <br />
</syntaxhighlight><br />
<br />
And finally some code using the new functions<br />
<syntaxhighlight lang="autoit"><br />
Local $arr1[1]<br />
ArrayFiller($arr1)<br />
dbgArray($arr1)<br />
</syntaxhighlight><br />
<br />
This code is a test on what happens when we pass a regular variable.<br />
<syntaxhighlight lang="autoit"><br />
Local $arr2<br />
ArrayFiller($arr2)<br />
dbgArray($arr2)<br />
</syntaxhighlight><br />
<br />
== Returning Arrays From Functions ==<br />
<br />
As you could observe, in the previous samples, an array will be passed back and forth with the ByRef keyword infront of the variable holding the array in the function declaration.<br />
<br />
We could also have used the Return keyword in a function.<br />
Lets re-work the ArrayFiller function to do this rather than using a variable ByRef.<br />
<br />
<syntaxhighlight lang="autoit"><br />
Func ArrayFiller2()<br />
Local $arr = [3, "Fill 1", "Fill 2"]<br />
Return $arr<br />
EndFunc <br />
</syntaxhighlight><br />
<br />
And now we can use the function like this<br />
<br />
<syntaxhighlight lang="autoit"><br />
Local $foo = ArrayFiller2()<br />
dbgArray($foo)<br />
</syntaxhighlight><br />
<br />
== Comparing Arrays ==<br />
<br />
'''You can not compare complete arrays:'''<br/><br />
<syntaxhighlight lang="autoit"><br />
Local $Array1[3] = [1, 2, 3]<br />
Local $Array2[3] = [1, 2, 3]<br />
Local $Array3[4] = [1, 2, 3, 4]<br />
<br />
If $Array1 == $Array2 Then ConsoleWrite("1.) $Array1 is equal to $Array2! which might be correct in some sense." & @LF); while they contain the same data, the comparison does not work.<br />
<br />
If $Array1 == $Array3 Then ConsoleWrite("2.) $Array1 is equal to $Array3! which is incorrect." & @LF); even though they're different in size, it's incorrectly determined that they're equal.<br />
</syntaxhighlight><br />
<br />
I have the impression that such comparisons compare the memory address of the arrays instead of the array elements values. And the addresses are always different for different arrays. You have to instead, compare all elements one after the other. It might be a good idea to first compare array sizes if that can vary for both the compared arrays!<br />
<br />
The next example creates an array from user input and then compares elements from a 1D Array to the first column of a 2D array to return the matches as words.<br />
<syntaxhighlight lang="autoit"><br />
; sample number string split and convert to words<br />
; uncomment the ConsoleWrite and _ArrayDisplay lines to see what it does<br />
;# some includes<br />
#include <Array.au3><br />
<br />
;# some variables<br />
<br />
;Create 2D array to display<br />
Local $aWords[10][2] = [[0, 'nil'] _<br />
, [1, 'one'] _<br />
, [2, 'two'] _<br />
, [3, 'three'] _<br />
, [4, 'four'] _<br />
, [5, 'five'] _<br />
, [6, 'six'] _<br />
, [7, 'seven'] _<br />
, [8, 'eight'] _<br />
, [9, 'nine']] ; :)<br />
<br />
;~ _ArrayDisplay($aWords)<br />
<br />
; the order of the sample digits is to show that the comparison below is accurate, from left to right<br />
Local $Originalinput = InputBox("Type a number", "A number?","97524601")<br />
<br />
Local $userinput = $Originalinput ; pass the orginal input to a second var<br />
; now parse the userinput to that we know what was submitted, then repeat in words<br />
; first strip all white space<br />
$userinput = StringStripWS($userinput, 8)<br />
<br />
If StringIsDigit($userinput) Then ; continue<br />
<br />
; now get the length of the string<br />
Local $islong = StringLen($userinput)<br />
<br />
; make an array with size = length to insert items into<br />
Local $aInput[1] ; create blank one dimensional array<br />
;~ _ArrayDisplay($aInput)<br />
; eat the string one digit at a time :)<br />
Local $oneleft<br />
For $i = 1 To $islong Step 1<br />
$oneleft = StringLeft($userinput, 1)<br />
ConsoleWrite("$oneleft: " & $oneleft & @CRLF)<br />
$userinput = StringTrimLeft($userinput, 1) ; make the $userinput one shorter on each loop<br />
_ArrayAdd($aInput, $oneleft, 1)<br />
Next<br />
;~ _ArrayDisplay($aInput)<br />
; now write out what the user typed in words<br />
<br />
;~ ConsoleWrite("How long is the string: " & $islong & @CRLF)<br />
; compare the user input to our defined array<br />
For $k = 0 To $islong Step 1<br />
For $j = 0 To (UBound($aWords) - 1) Step 1<br />
;~ ConsoleWrite("Compare $j " & $aWords[$j][0] & " to $k " & $aInput[$k] & @CRLF)<br />
If $aWords[$j][0] == $aInput[$k] Then<br />
MsgBox(0, "Number to word", $Originalinput&@CRLF&"User typed "& $aInput[$k]& @CRLF & $aWords[$j][1] & @CRLF,1)<br />
EndIf<br />
;~ ConsoleWrite("For... Next inner loops: " & $k & @CRLF)<br />
Next<br />
;~ ConsoleWrite("For... Next outer loops: " & $j & @CRLF)<br />
Next<br />
<br />
EndIf ; if its not digits, skip<br />
<br />
</syntaxhighlight><br />
<br />
== Multi Dimensional Arrays ==<br />
<br />
Now what is a good explanation of a multi-dimensional array?<br />
It could be a table where you access one item in the table at a time.<br />
<br />
<syntaxhighlight lang="autoit"><br />
Local $arr[3][3] = [[1, 2, 3], [2, 3, 4], [3, 4, 5]]<br />
<br />
For $i = 0 to UBound( $arr, 1) - 1<br />
For $j = 0 to UBound($arr, 2) - 1<br />
ConsoleWrite("$arr[" & $i & "][" & $j & "]:=" & $arr[$i][$j] & @LF)<br />
Next <br />
<br />
ConsoleWrite(@LF)<br />
Next <br />
</syntaxhighlight><br />
<br />
You can add a number of dimensions not to exceed sixty-four as stated in the help file section [http://www.autoitscript.com/autoit3/docs/appendix/LimitsDefaults.htm AutoIt3 limits/Defaults].<br />
<br />
Here is a four dimensional example. You tell me how that initializer is for readability.<br />
<br />
<syntaxhighlight lang="autoit"> <br />
; NOTE: The following is supposed to be all on one line<br />
; but we use the "_" character to split it into multiple lines for readability<br />
<br />
Local $arr[3][3][3][3] = _<br />
[ _<br />
[ _<br />
[[1, 2, 3], [2, 3, 4], [3, 4, 5]], _<br />
[[1, 2, 3], [2, 3, 4], [3, 4, 5]], _<br />
[[1, 2, 3], [2, 3, 4], [3, 4, 5]] _<br />
], _<br />
[ _<br />
[[1, 2, 3], [2, 3, 4], [3, 4, 5]], _<br />
[[1, 2, 3], [2, 3, 4], [3, 4, 5]], _<br />
[[1, 2, 3], [2, 3, 4], [3, 4, 5]] _<br />
], _<br />
[ _<br />
[[1, 2, 3], [2, 3, 4], [3, 4, 5]], _<br />
[[1, 2, 3], [2, 3, 4], [3, 4, 5]], _<br />
[[1, 2, 3], [2, 3, 4], [3, 4, 5]] _<br />
] _<br />
]<br />
<br />
For $i = 0 To UBound($arr, 1) - 1<br />
For $j = 0 To UBound($arr, 2) - 1<br />
For $k = 0 To UBound($arr, 3) - 1<br />
For $l = 0 To UBound($arr, 4) - 1<br />
ConsoleWrite("$arr[" & $i & "][" & $j & "][" & $k & "][" & $l & "]:=" & $arr[$i][$j][$k][$l] & @LF)<br />
Next<br />
Next<br />
Next<br />
Next<br />
<br />
ConsoleWrite(@LF)<br />
</syntaxhighlight><br />
<br />
== Arrays in Arrays ==<br />
<br />
You may save an array in an array element (item). Remember that there may be issues if you pass an array containing arrays into a function and the embedded array is changed inside that function. So, as a general rule, try not to embed arrays within arrays unless you absolutely need to and are prepared to do rigorous testing to make sure your code will always work as expected.<br />
<br />
You can access the elements of these embedded arrays directly (note the additional () required):<br />
<br />
<syntaxhighlight lang="autoit"><br />
Local $aContainerArray[2]<br />
Local $aInternalArray_0[2] = ["Internal-0-0","Internal-0-1"]<br />
Local $aInternalArray_1[2] = ["Internal-1-0","Internal-1-1"]<br />
$aContainerArray[0] = $aInternalArray_0<br />
$aContainerArray[1] = $aInternalArray_1<br />
<br />
ConsoleWrite("1 element of InternalArray_0: " & ($aContainerArray[0])[1] & @CRLF)<br />
ConsoleWrite("0 element of InternalArray_1: " & ($aContainerArray[1])[0] & @CRLF)<br />
</syntaxhighlight><br />
<br />
== More Information ==<br />
<br />
AutoIt features a large list of [http://www.autoitscript.com/autoit3/docs/libfunctions.htm User Defined Functions (UDF)], among which is a module supplying extra array functions. You can find a reference on those functions in AutoIt's Help file as the last main chapter named [http://www.autoitscript.com/autoit3/docs/libfunctions.htm User Defined Functions Reference].<br />
<br />
[[Category:Tutorials]]</div>Skysnakehttps://www.autoitscript.com/w/index.php?title=User_Defined_Functions&diff=13235User Defined Functions2015-09-15T15:54:26Z<p>Skysnake: /* Databases and web connections */</p>
<hr />
<div>This page is a listing of libraries of '''user defined functions''' (UDF). These libraries have been written to allow easy integration into your own scripts and are a very valuable resource for any programmer.<br />
This list is probably not complete (245 UDFs on 2015/08/16), but constantly supplemented.<br />
If you do not find a solution here, ask a new question on the [http://www.autoitscript.com/forum/forum/2-general-help-and-support/ forum].<br />
<br />
== Automation ==<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=106163 Active Directory (by water)] - Extensive library to control and manipulate the Windows active directory. Link to the [[Active_Directory_UDF_-_General|documentation]] pages.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=150231 GTK+ (by prazetto)] - GTK+ Framework | Widgets.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=153520 IUIAutomation MS framework (by junkew)] - IUIAutomation MS framework to automate chrome, FF, IE etc.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=87956 Java (by seangriffin)] - Creates an access bridge between your application and a Java application. Allowing you to automate some Java applications.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=86574 SAP (by seangriffin)] - SAP business management automation.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=149540 SAPWizard (by ozmike)] - SAPWizard UDF.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=80201 Service (by arcker)] - Build your own service with AutoIt code.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=91018 WiFi (by MattyD)] - Low level control over your wireless LAN.<br />
<br />
===Browsers===<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=154439 Chrome (by seangriffin)] - The same as above for Google Chrome. Automate the most common tasks in Chrome with the Chrome UDF.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=95595 Firefox (by Stilgar)] - A little less support for automation than IE, but still very good.<br />
* [https://www.autoitscript.com/forum/files/file/224-firefox-profile-backup/ FireFox Profile Backup 1.0 (by careca)] - Backup or restore your firefox profile, the application searches for the profile in home drive, That will be the one to backup.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=124330 _FF_AutoLogin (by Stilgar)] - This is a auto-login function and login-function-generator for FireFox and the FF.au3.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=92035 _FF_DM (by Stilgar)] - UDF to control the FireFox Download-Manager (not the download-window).<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=91650 _FF_FoxBox (by Stilgar)] - UDF to control Fox!Box (A Mozilla Firefox extension for the AVM FRITZ!Box) with FF.au3.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=91665 _FF_Screengrab (by Stilgar)] - UDF to control Screengrab! (FireFox-AddOn) with FF.au3.<br />
* [http://www.autoitscript.com/forum/topic/124330-_htmlau3-v101/ _HTML (by Stilgar)] - Get informations from any HTML (XML) source, without any browser.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=166542 HTMLDocumentEvents (by SmOke_N)] - Track IE document events.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=167035 IEEx (by SmOke_N)] - IE extended library with some Javascript options<br />
* Internet Explorer (by DaleHohm et al.) - Everything about Internet explorer can be automated with the IE library supplied with a standard AutoIt install.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=149203 NavInfo (by Nessie)] - With this UDF you can check if a specified browser/software is installed and which version is being used.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=61090 Opera (by MrCreatoR,)] - The same as above for Opera. Automate the most common tasks in Opera with the Opera UDF.<br />
<br />
===Microsoft Office===<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=32144 Microsoft Office Access (by randallc)] - Automate Microsoft Access.<br />
* Microsoft Office Excel (by water et al.) - This UDF is included in AutoIt. Link to the [[Excel_UDF|documentation]] pages.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=135312 Microsoft Office Excel Charts (by water, GreenCan)] - Creating charts using Microsoft Excel.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=126305 Microsoft Office Outlook (by water)] - Automate Microsoft Outlook. Link to the [[OutlookEX_UDF_-_General|documentation]] pages.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=50254 Microsoft Office PowerPoint (by Toady)] - Automate Microsoft PowerPoint.<br />
* Microsoft Office Word (by water et al.) - This UDF is included in AutoIt. Link to the [[Word_UDF|documentation]] pages.<br />
<br />
===OpenOffice===<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=151530 OOo/LibO Calc (by GMK)] - OpenOfficeCalc UDF.<br />
<br />
== Databases and web connections ==<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=105875 ADODB (by spudw2k)] - ADODB Example.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=145142 DBF (by funkey)] - dBase database read and write with DLL.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=116072 EzMySql (by oriz)] - EzMySql - Use MySql Databases with autoit.<br />
* [http://www.autoitscript.com/forum/topic/94920-solved-passing-parameters-using-dllcall-to-a-c-dll/?do=findComment&comment=684751 FireBird (by eltorro)] - FireBird, Interbase dll udf.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=127101 MS SQL (by TheLuBu)] - MSSQL.au3.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=51952 MS SQL (by ChrisL)] - _SQL.au3. ADODB Connection.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=20814 MySQL (by cdkid)] - MySQL relational database management system UDF.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=85617 MySQL (by ProgAndy)] - MySQL UDFs (without ODBC).<br />
* [https://www.autoitscript.com/forum/topic/122360-mysql-odbc-connector-udf MySQL (by James)] - MySQL ODBC Connector.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=17099 SQLite (by ptrex)] - SQLite is a library that implements a self-contained, embeddable, zero-configuration SQL database engine.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=142977 SQLite Array Functions (by SmOke_N)] - SQLite Array Functions - a faster method for unique arrays and sorting methods.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=19848 XML DOM Wrapper (by eltorro)] - Supports CRUD operations on XML. Including XSL and XPath.<br />
* [https://www.autoitscript.com/forum/topic/173984-the-combination-of-autoit-php-and-mysql/ AutoIt PHP MySQL (by J2TeaM)] - The combination of AutoIt, PHP and MySQL.<br />
<br />
== Data compression ==<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=85094 7z, zip, gzip, bzip2, tar (by rasim)] - Extensive library that uses a external DLL that must be provided with the script.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=87441 LZMA (by trancexx)] - LZMA (Native Windows).<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=112273 LZMA Compression (by Ward)] - LZMA Compression UDF.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=166634 MessagePack (by Ward)] - MessagePack is an efficient binary serialization format. It lets you exchange data among multiple languages like JSON. But it's faster and smaller.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=138838 Package (by Yashied)] - Package UDF.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=129529 pZip (by asdf8)] - PureZIP_L library UDF.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=76176 UnRAR (by rasim)] - UnRAR.au3.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=44524 Zip plugin (by eltorro)] - Zip plugin.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=73425 ZIP (by torels)] - ZIP.au3 UDF in pure AutoIt.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=116565 zip (by wraithdu)] - Create ZIP files and unpack ZIP files.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=135565 ZIP (by joakim)] - ZIP STRUCTS UDF (from scratch).<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=128962 zLib (by Ward)] - zLib (Deflate/Inflate/GZIP) UDF.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=17727 XZip (by eltorro)] - another UDF for "XStandard XZIP Component".<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=161847 XZip (by mLipok)] - UDF for "XStandard XZIP Component".<br />
<br />
== Encryption and hash ==<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=78745 AES Rijndael (by Ward)] - Very fast AES UDF. Support ECB/CBC/CFB/OFB block cipher mode.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=76976 MD5,SHA1,CRC32,RC4,BASE64,XXTEA (by Ward)] - Several encryption and hash functions.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=107784 TrueCrypt (by FuryCell)] - TrueCrypt UDFs.<br />
<br />
== GUI Additions ==<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=97241 3D Pie chart (by WideBoyDixon)] - 3D Pie chart.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=173924 Chart_UDF (by Kanashius)] - This UDF can be used to Display bar charts in a window.).<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=96258 ContextHelp.au3 (by Yashied)] - Management of context help ([http://www.autoitscript.com/forum/index.php?showtopic=72152-contexthelp/ original]).<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=113723 Easy Scrollbars (by Melba23)] - Easily create scrollable sections in your GUI.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=109096 ExtMsgBox (by Melba23)] - A very customisable replacement for MsgBox.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=105582 GUICtrlOnChangeRegister (by Mat)] - Call a function when an edits content is changed.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=145149 GUIExtender (by Melba23)] - Expand and contract sections of your GUI ([http://www.autoitscript.com/forum/index.php?showtopic=117909 original]).<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=119505 GUIFrame (by Melba23 & Kip)] - Divide a GUI into adjustable frames.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=144207 GUI Panel (by FireFox)] - Manage child GUIs as panel ctrls.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=20967 Modern tray menu (by Holger)] - Allows the creation of modern, fancy GUI and tray menus with icons and colors.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=161750 Pie chart (by Andreik)] - Pie chart.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=71811 SetOnEvent (by martin)] - Provides an easy way for an event to call functions with parameters.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=132864 Uskin (by JScript)] - A library that allows a user to skin their application GUI using the Windows ''.MSstyles'' files.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=108445 Toast (by Melba23)] - Small message GUIs which pop out of the Systray.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=32494 XSkin (by Valuater)] - A large library that allows skinning of your GUI and to apply custom skins.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=75429 Real Vista Aero Glass (by James)] - Real Vista Aero Glass UDF - you can apply glass effect to your gui.<br />
<br />
=== Controls ===<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=146406 Calendar (by jmon)] - Calendar UDF.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=96464 Colorpicker (by Yashied)] - Create a button for the user to select a color.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=173929 GDIPlus Slider UDF (by Kanashius)] - This UDF can be used to create a slider with an imagebackground and an image to move.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=79412 Graph control (by andybiochem)] - Easily create and show bar chart and line charts.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=104399 GraphGDIPlus UDF (by andybiochem)] - Easily create and show bar chart and line charts with GDI+ to take advantage of double-buffering.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=105682 GUICtrlCreateFinder (by Mat)] - Allows you to create a window finder control like the one seen in AutoIt Window Info.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=166594 GUITreeViewEx (by Melba23)] - Check/clear parent and child checkboxes in a TreeView.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=107965 GUIHotkey (by Mat)] - UDF for using native hotkey controls.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=111438 GUIPager (by Mat)] - Create and control native pager controls.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=20967 GUI/Tray Menu (by Holger, LarsJ, AZJIO)] - GUI/Tray Menu with icons and colors.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=90598 Hotkey input control (by Yashied)] - Hotkeys Input Control UDF Library (Non-native).<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=173932 ListView Edit UDF (by Kanashius)] - This UDF can be used to simply edit an Listview.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=143711 Marquees (by Melba23)] - Make tickertape info bars.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=74649 Progressbar with GDIplus (by ProgAndy)] - You even can use full textured images.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=128242 Ribbon (by trancexx)] - UDF for Windows Ribbon framework.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=126958 Syslink (by Yashied)] - Provides a convenient way to embed hypertext links in a window.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=105814 Table (by andybiochem)] - Table UDF.<br />
<br />
== Hardware ==<br />
* [[CommAPI]] (by therealhanuta) - Serial and parallel communication (COM port, RS-232, LPT port) - without installing DLL's (using Windows API calls).<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=77731 Device Management (by weaponx)] - Device Management API.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=97487 DirectShow (by monoceres)] - DirectShow UDF.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=164700 DirectSound (by eukalyptus)] - DirectSound UDF.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=164701 Direct2D (by eukalyptus)] - Direct2D UDF.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=138989 FritzBox (by Allow2010)] - _FB_Tools - manage your FritzBox from Autoit.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=121084 I/O Port Functions (by Ascend4nt)] - Input/Output UDF for interacting with ports (x64 Parallel Port, Keyboard etc.).<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=154350 Monitor Configuration (by jaberwacky)] - Monitor Configuration UDF.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=155469 Mouse (by AlmarM)] - AutoIt powered mouse events.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=147325 MouseTrapEvent (by ozmike)] - MouseTrapEvent UDF.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=149083 NetInfo (by Nessie)] - UDF for test internet download speed and upload speed.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=155539 Network configuration (by jguinch)] - Network configuration UDF.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=128546 Serial Port/COM (by martin)] - Serial Port /COM Port UDF.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=27755 SMARTDRIVE (by ptrex)] - SMART drive Analysis.<br />
* [http://www.autoitscript.com/forum/topic/158640-spi-hardware-interface SPI Hardware Interface (by Blinky)] - Communicate with the MAX335 chip using the SPI protocol via the LPT (printer) port.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=68866 Webcam (by LIMITER)] - Webcam UDF.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=70857 Webcam (by ludocus)] - Webcam UDF.<br />
<br />
== Information gathering ==<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=29404 Computer information (by JSThePatriot)] - A general purpose library to get various details about a Windows machine.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=54039 WinPcap (by JRSmile)] - Wrapper for the windows packet capture library WinPcap.<br />
* [http://opensource.grisambre.net/pcapau3/ WinPcap (by Nicolas Ricquemaque)] - A library to access the main functionalities offered by the WinPcap driver.<br />
<br />
== Internet protocol suite ==<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=137456 cURL (by seangriffin)] - A UDF for transferring data with URL syntax.<br />
* [http://www.autoitscript.com/forum/topic/173067-curl-udf-autoit-binary-code-version-of-libcurl-with-ssl-support/ cURL (by Ward)] - AutoIt binary code version of libcurl with SSL support.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=40243 IMAP (by mikeytown2)] - IMAP.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=108422 IMAP4 (by Tipulatoid)] - IMAP4 UDF.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=43515 IRC (by McGod)] - A lightweight library for communicating with IRC servers.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=159285 IRC (by rcmaehl)] - IRC UDF - Updated Version of Chips' IRC UDF.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=104150 JSON (by Gabriel13)] - RFC4627 compliant JSON encode/decode.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=148114 JSON (by Ward)] - JSMN - A Non-Strict JSON UDF.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=156794 JSON (by ozmike)] - Bridge to Native Windows JSON plus OO extension for AutoIt.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=173797 JSONgen: JSON generator (by Jefrey)] - UDF to generate JSON.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=22838 POP3 (by Apzo)] - POP3 library for retrieving email messages. Not compatible with Gmail because it uses SSL.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=167339 _POP3_Ex (by mLipok)] - POP3 UDF According to the 1939 RFC, modified version with Quoted Printable decoder.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=64051 POP3 SSL (by Fox2)] - A POP3 library that's compatible with Gmail. It uses an external executable that must be supplied with your script.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=154530 Prowl (by mrflibblehat)] - Push notifications to iPhone, iPod touch or iPad using Prowl (Growl client for iOS).<br />
* [http://www.autoitscript.com/forum/topic/173129-request-udf-the-simplest-way-to-make-http-request Request (by Ward)] - Powerful and easy-to-use HTTP client for AutoIt based on Curl.au3 and Json.au3.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=138095 SFTP (by Lupo73)] - UDF to support SFTP protocol using PSFTP.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=23860 SMTP (by Jos)] - Smtp Mailer That Supports Html And Attachments.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=81687 SNMP (by enaiman)] - SNMP_UDF for SNMPv1 and SNMPv2c.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=70759 SNMP - MIB protocol (by ptrex)] - Reading toner status from SNMP device with WMI.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=166579 SSH (by jeanphile)] - Use the SSH protocol very easily in your code.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=169774 TCPServer (by Jefrey)] - Multi client, event-based, able to bind console app to socket.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=57022 UPnP Protocol (by ptrex)] - UPnP - Read and Control your devices in side out.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=84133 WinHTTP (by trancexx)] - Access the HTTP protocol for creating GET and POST requests and submitting them with conforming standards, cookies not supported.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=77503 WinInet (by -Ultima-)] - Access standard Internet protocols (FTP, Gopher and HTTP). Supports GET/POST requests and cookies.<br />
<br />
== Maths ==<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=170658 Advanced Math UDF (by scintilla4evr)] - This is an UDF full of advanced mathematical functions. It allows to work with primes, create number sequences, interpolate, calculate values of functions like Riemann zeta.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=102686 Advanced rounding (by Mat)] - Support for different measures of accuracy and 8 ways to resolve tie breaks.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=83529 Big number (by eukalyptus)] - Make calculations with extremely large numbers that AutoIt normally is not able to support.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=106551 Decimal To fraction (by Malkey)] - Converts any decimal number to a fraction. Example: 1.2 to 6/5.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=81189 Number base conversion (by james3mg)] - From, to and between positive bases less than 63 (decimals supported).<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=117156 NumToWord (by Mat)] - Convert numerals to a human readable string.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=108803 Polynomials (by Mat)] - Functions for using polynomials.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=83091 Primes (by jennico)] - Many functions dealing with prime number generation and calculations.<br />
* [http://www.autoitscript.com/forum/topic/94770-integer-to-roman-numerals/#entry1043544 Roman Numerals (by AZJIO)] - Roman Numerals.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=98160 Root function (by Mat)] - Working out real roots of numbers.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=163899 StringAPL (by minx)] - inline APL interpreter.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=82722 Trigonometry math functions (by trancexx)] - _ATan2(), _Cosh(), _Frexp(), _Hypot(), _Ldexp(), _Logb(), _Sinh(), _Tanh().<br />
<br />
== Media ==<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=95357 FreeImage library (by ProgAndy)] - Various operations on images, such as rotate, resize, flip.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=127263 HtmlHelp (by Geodetic)] - HtmlHelp UDF.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=50608 OCR (by ptrex)] - Real OCR in AU3 - MODI with MS Office 2003.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=89542 OCR (by seangriffin)] - Tesseract (Screen OCR) UDF.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=51054 Printer controller (by martin)] - Print text in any font, size and colour at any position on the page, draw lines, curves, elipses, pies in any colour, and print images.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=73993 Printing (by GRS)] - Printing from AutoIt.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=161831 RTF_Printer (by mLipok)] - RTF_Printer.au3 - Printing RichEdit in the background.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=94834 Simple DirectMedia Layer (by AdmiralClaws)] - Adds support for joysticks, CDs, 2D graphics, timers. See [http://www.libsdl.org/ SDL website] for more information.<br />
<br />
===Graphics and image===<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=27362 Bitmap Library (by evilertoaster)] - Bitmap Library.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=70506 IrrLicht (by A. Percy)] - A 3D graphics engine suitable for creating games.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=113881 au3Irrlicht2 (by JRowe)] - Another UDF bringing Irrlicht and au3 together. Historically some kind of a follower of the UDF above, technically with a complete different approach.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=13096 ImageGetInfo (by Lazycat)] - This is an UDF for reading info from JPEG, TIFF, BMP, PNG and GIF - size, color depth, resolution.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=151011 OpenGL (by LarsJ)] - OpenGL without external libraries etc. For JPEG files UDF also retreive various Exif information.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=148129 OpenGL (2.0) (by minx)] - new set of UDFs for OpenGL + AutoIt.<br />
<br />
===Players===<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=114143 VLC (by seangriffin)] - VLC (Media Player) UDF.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=91316 VLC Media Player (by ptrex)] - VLC Media Player.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=27352 WMP (by ConsultingJoe)] - Windows Media Player UDF.<br />
<br />
===Sound===<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=83481 BASS Function Library (by BrettF)] - Sound and Music via wrappers for Bass, BassEnc, Bass FX, BassSFX, BassAsio and BassCd DLLs.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=37072 MIDI (by eynstyne)] - MIDI UDF.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=114742 SAPIListBox (by seangriffin)] - SAPIListBox (Speech Recognition) UDF.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=100439 TTS (by Beege)] - Text-to-Speech UDF.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=173808 libZPlay (by Danyfirex)] - UDF for libZPlay - multimedia library for playing mp3, mp2, mp1, ogg, flac, ac3, aac, oga, wav and pcm files and streams.<br />
<br />
== PDF ==<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=162195 Acrobat Reader - ActiveX Viewer (by mLipok)] - Make your own PDF Viewer GUI with Acrobat Reader ActiveX COM Object "AcroPDF.PDF.1"<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=164469 Debenu PDF Viewer SDK (by mLipok)] - A collection of functions to display PDF files in your applications using Debenu PDF Viewer SDK.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=160875 Debenu Quick PDF Library (by mLipok)] - A collection of functions for Debenu Quick PDF Library.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=75832 FoxIt Reader (by ptrex)] - PDF Reader in AU3.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=118827 MPDF (by taietel)] - Create PDF from your application.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=42776 PDFCreator (by ptrex)] - Automation of PDFCreator allows you to create and manipulate PDF files.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=170550 PDFCreator (by mLipok)] - UDF for PDFCreator v1.x.x with working EVENTs Handler.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=32261 _StringToPDF (by Tam0r)] - Write a string to a PDF file and specify font size, type etc.<br />
<br />
== Security ==<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=150819 VirusTotal (by Danyfirex)] - VirusTotal API 2.0 UDF.<br />
<br />
== Social Media and other Website API ==<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=169333 CrowdinAPI (by mLipok)] - UDF using the [https://crowdin.com/page/api crowdin.net website API] for some functions (create projects, add and update files, download translations or integrate localization).<br />
* [http://www.autoitscript.com/forum/files/file/290-dropbox-authenticator/ Dropbox authenticator (by Gimerly)] - Dropbox authenticator.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=158106 Easypost (by dcat127)] - Print USPS Postage Labels.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=114801 eBay (by seangriffin)] - eBay UDF (functions GetItemStatus and GetSingleItem from the "Shopping API").<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=141340 Gmail (by PhoenixXL)] - Remote Gmail (UDF).<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=98504 Google Functions (by Beege)] - Google Functions (Suggestions, Definitions, Translate, Convert).<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=115437 Google Maps (by seangriffin)] - Google Maps UDF.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=70675 iTunes (by torels)] - iTunes UDF.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=101802 iTunes (by Beege)] - Another iTunes UDF.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=150985 No-IP (by Nessie)] - With this UDF you can simply update your no-ip hostname(s) and retrive the ip address of an no-ip address.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=150838 PasteBin (by mrflibblehat)] - Pastebin UDF.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=121767 Skype (by FireFox)] - Skype4COM provides an ActiveX interface to the Skype API.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=113234 Teamspeak 3 (by chipDE)] - Teamspeak 3 UDF.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=166205 TeamViewer API (by mLipok)] - UDF for TeamViewer API - a modest beginning.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=166547 TVmaze.com API (by BBs19)] - TVmaze.com API UDF (TV-Series).<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=116600 Twitter (by seangriffin)] - Twitter UDF.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=149247 Yahoo Weather (by Nessie)] - YWeather UDF - Yahoo Weather API.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=112775 Youtube Uploader (by BrettF)] - AYTU - AutoIt Youtube Uploader.<br />
<br />
== Windows ==<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=50880 ACL (by ptrex)] - Set ACL on windows Objects.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=113560 FileSystemMonitor (by seangriffin)] - FileSystemMonitor UDF.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=145158 Firewall (by JLogan3o13)] - Windows Firewall UDF.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=111018 ITaskBarList (by Beege)] - ITaskBarList UDF.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=74118 Local account (by engine)] - Local account UDF.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=161193 Magnifier Functions (by Ascend4nt)] - This UDF exposes most of the useful Magnifier API functions available since Windows Vista.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=75250 Registry (by engine)] - Windows Registry UDFs.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=50551 Registry (by seanhart)] - RegWriteAllUsers / RegDeleteAllUsers.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=124508 Startup (by guinness)] - Create Startup entries in the Startup Folder or Registry.<br />
* [http://www.autoitscript.com/forum/topic/164756-sccm-udf/ SCCM (by JLogan3o13)] - Systems Center Configuration Manager Library.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=134628 System restore (by FredAI)] - System restore UDF.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=135994 Taskplanner/Taskscheduler COM (by Allow2010)] - an UDF for using the Windows Taskplaner / Task Scheduler.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=83355 Task Scheduler (by dbzfanatic)] - Task Scheduler UDF.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=173934 TTS UDF (by Kanashius)] - UDF for use with SAPI Automation Object - text-to-speech (TTS) engine<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=158377 UAC (by AdamUL)] - User Account Control (UAC) UDF.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=127075 WIMGAPI (by Homes32)] - A UDF for manipulating Windows Image Files (.wim) without ImageX.exe.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=28436 Windows Events (by Emperor)] - Create your own Windows events.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=81880 Windows Services (by engine)] - Windows Services UDF.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=163178 WRMF (by Luigi)] - WRMF - Windows Registry Monitor Call Function.<br />
<br />
== Misc ==<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=160936 Android (by Moriba)] - Android UDF.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=97826 Animated tray icons (by Yashied)] - Make animated tray icons easily.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=163577 Atom Table (by Ascend4nt)] - Store strings locally (at program level) or globally (at OS level) with unique numerical identifiers. This UDF lets you add, find, delete, and query these atoms.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=170087 Barcode generators (by willichan)] - Creates a Code128A/B/C or Creates a Code39 or Code39Extended optimized barcode from supplied data.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=131037 Binary (by Ward)] - Binary UDF.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=162366 BinaryCall (by Ward)] - BinaryCall UDF - Write Subroutines In C, Call In AutoIt.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=81267 Clipboard History (by wraithdu)] - Save and restore the entire clipboard contents. Inspired by AHK's ClipboardAll.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=169610 CmdLine (by Jefrey)] - Collection of functions to parse command line arguments.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=121833 Copy (by Yashied)] - Copy or move files and directories without suspending your script. Retrieve the current state (copied bytes, error code etc.) while copying.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=55994 DDEML (by doudou)] - With DDEML UDF one can use an AutoIt script as a DDE client or server.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=99106 _DLLStructDisplay (by Ascend4nt)] - Show Struct in ListView.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=111613 FASM (by Ward)] - The Embedded Flat Assembler (FASM) UDF.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=157689 _FileGetMimeType (by Wiliat87)] - _FileGetMimeType UDF.<br />
* [http://www.autoitscript.com/forum/topic/117033-file-locking-with-cooperative-semaphores File locking with cooperative semaphores (by willichan)] - Simple file locking without a server.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=157241 FindMimeFromData (by twbradio)] - FindMimeFromData using urlmon.dll.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=90492 Hotkey.au3 (by Yashied)] - Management of Hotkeys UDF, with several advantages over HotkeySet().<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=86672 Inline Assembly (by Ward)] - Assembles the code to binary machine code and runs it.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=161628 LFN (by orbs)] - LFN UDF - overcome MAX_PATH limit of 256 chars.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=173946 LASM - Light Assembler (by minxomat)] - This is the Inline UDF for an Assembler<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=77463 MemoryDll (by Ward)] - Embed DLLs in script and call functions from memory.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=101733 NoFocusLines (by Melba23)] - Remove the dotted focus lines from buttons, sliders, radios and checkboxes which spoil the look of your GUI.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=149176 NotifyIcon (by FireFox)] - NotifyIcon UDF (formerly TrayIconEx) - Create, delete and manage self notify icons.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=63318 PixelGetColor (by Manadar)] - Get or Read Pixel from Memory UDF.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=167024 RDC (by Yashied)] - ReadDirectoryChanges Wrapper.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=51103 Resources (by Zedna)] - Resources UDF.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=162499 ResourcesEx (by guinness)] - ResourcesEx UDF (up to date with the current AutoIt language syntax v3.3.12.0).<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=162033 Spell Checker (by iCode)] - Spell Checker UDF - Hunspell.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=114034 StringSize (by Melba23)] - Automatically size controls to fit the text you want to put in them.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=164444 Synology filestation (by nend)] - UDF for users of Synology NAS server.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=125251 TVExplorer (by Yashied)] - TVExplorer UDF.<br />
* [http://www.autoitscript.com/forum/index.php?showtopic=51547 SciLexer (by Kip)] - SciLexer UDF.<br />
[[Category:UDF]]</div>Skysnake