Report Help File Issues Here

[AZJIO]

guinness

This example does not have a problem with the encoding when outputting the result with the Russian letters

StdoutRead

#include <Array.au3>
#include <Constants.au3>
$sPath = @ScriptDir
$sFileMask = '*.*'
$sOut = ''
If Not StringInStr(FileGetAttrib($sPath), "D") Then Exit
$sOut = StringToBinary('0' & @CRLF, 2)
$sPath = StringRegExpReplace($sPath, '+$', '')
$iPID = Run(@ComSpec & ' /U /C DIR "' & $sPath & '' & $sFileMask & '" /B /S /A-D', @SystemDir, @SW_HIDE, $STDERR_CHILD + $STDOUT_CHILD)
While 1
$sOut &= StdoutRead($iPID, False, True)
If @error Then ExitLoop
Wend
$aOut = StringRegExp(BinaryToString($sOut, 2), '[^rn]+', 3)
If @error Or UBound($aOut) < 2 Then Exit
$aOut[0] = UBound($aOut)-1
_ArrayDisplay($aOut, 'all files')

[guinness]

Thanks, I did wonder if I should use the /U option so I'll think about it as I don't want to make the example too complex.

[AZJIO]

You can leave StdioClose and StdoutRead with different types of

Add a comment that StdioClose ($ iPID) you can comment if you want to get the result

TrayCreateItem

Must demonstrate the "Radio"

Edited February 6, 2012 by AZJIO

[guinness]

You can leave StdioClose and StdoutRead with different types of

Add a comment that StdioClose ($ iPID) you can comment if you want to get the result

OK, will do.

TrayCreateItem

Must demonstrate the "Radio"

OK.

[AZJIO]

guinness

In Dim.au3 can add examples to declare arrays with different dimensions

; Example 4
#include <array.au3>
Global $Array[2] = ['element1', 'element2']
_ArrayDisplay( $Array, "Array 1" )
Dim $Array[8] = [0]
_ArrayDisplay( $Array, "Array 2" )
Dim $Array[3][2] = [[1,2],[3,4],[5,6]] ; 3 rows, 2 columns
_ArrayDisplay( $Array, "Array 3" )
Dim $Array[2][3] = [[1,2,3],[3,4,6]] ; 2 rows, 3 columns
_ArrayDisplay( $Array, "Array 4" )

Edited February 7, 2012 by AZJIO

[guinness]

guinness

In Dim.au3 can add examples to declare arrays with different dimensions

; Example 4
#include <array.au3>
Global $Array[2] = ['element1', 'element2']
_ArrayDisplay( $Array, "Array 1" )
Dim $Array[8] = [0]
_ArrayDisplay( $Array, "Array 2" )
Dim $Array[3][2] = [[1,2],[3,4],[5,6]] ; 3 rows, 2 columns
_ArrayDisplay( $Array, "Array 3" )
Dim $Array[2][3] = [[1,2,3],[3,4,6]] ; 2 rows, 3 columns
_ArrayDisplay( $Array, "Array 4" )

I was always under the impression using Dim was bad coding practice.

[water]

I was always under the impression using Dim was bad coding practice.

I've got the same impression because the help file states:

"You should use Local or Global, instead of Dim, to explicitly state which scope is desired for a variable/constant/array."

I think it's good coding practice to specify the scope.

[Melba23]

guinness,

It is - you should always make the scope explicit rather than rely on AutoIt's interpretation.

And it is not just me that says this - anyone want an argument now?

M23

[BrewManNH]

In this example, the Dim is being declared as Global because it's not inside a function. It doesn't matter if you use Dim or Global, or even Local in the example, the results are always the same, the array is redeclared with different dimensions and the array contents are lost.

[Valik]

The only time it's okay to use it is to declare an existing variable with a new size. Otherwise it's not the best choice to use. That example is okay-ish because it's re-using a global variable explicitly declared. But... it's using a global variable. Also, I'm not sure changing dimensions is the best thing to demonstrate. You really should only ever need to go from a non-array to an array (of arbitrary size and dimensions). If you are changing the number of dimensions (going from 1D to 2D) on an existing array then you are writing bad code. I do not think we should demonstrate writing bad code just because it's possible to write it.

[guinness]

Thanks all. In light of the recent comments I'll leave it as it is.

[AZJIO]

guinness

Now for me it not a problem, but I remember what problems and questions arose and as long it was impossible to place correctly square brackets, commas and indexes that it worked without errors.

MouseClick("left", 0, 500, 2)

screenshot

Exit ; Attention, check that a click will be safe
MouseClick("left", 0, 500, 2)

DirCopy (DirMove, FileCopy, etc.)

DirCopy(@MyDocumentsDir, "C:BackupsMyDocs", 1)

I have a folder " My Documents" several tens of gigabytes

Exit ; Attention, it only for an example.
DirCopy(@MyDocumentsDir, "C:BackupsMyDocs", 1)

Protection against the fool. Protection against the autopilot

GUICtrlRecvMsg

Local $a = GUICtrlRecvMsg($nEdit, $EM_GETSEL)
If @error Then ContinueLoop ; add this line

GUICtrlSetFont

GUICtrlCreateLabel("bold", 10, 80)
GUICtrlSetFont(-1, 9, 700, 0, $font)
GUICtrlCreateLabel("large", 10, 100, 110, 30)
GUICtrlSetFont(-1, 16, 400, 0, $font)

DriveSetLabel

DriveSetLabel(@HomeDrive & "", "New_Label")
DriveSetLabel("X:", "New_Label") ; - so it's best

OnAutoItExitRegister

In the description of the function "OnAutoItExitRegister" you can do the warning: you cannot assign the same function for the two events "$GUI_EVENT_CLOSE" and "OnAutoItExitRegister". This will force the function will be processed twice.

#include <GUIConstantsEx.au3>
Global $iC=0
Opt("GUIOnEventMode", 1)
GUICreate('My Program', 250, 260)
GUISetOnEvent($GUI_EVENT_CLOSE, "_Exit")
GUISetState ()
OnAutoItExitRegister("_Exit")
While 1
Sleep(1000)
WEnd
Func _Exit()
$iC+=1
MsgBox(0, '', $iC)
    Exit
EndFunc

GUISetHelp

GUISetHelp('hh.exe "'&@ProgramFilesDir&'AutoIt3AutoIt3.chm::/html/functions/GUISetHelp.htm"')

#include

; Create a file with this content Script.au3:
; ==> Beginning of the file Script.au3
#include "Time.au3"
MsgBox(4096,"", "Example")
#include "Time.au3"
; ==> this end of the file Script.au3
Exit
; Create a file with this content Time.au3:
; ==> Beginning of the file Time.au3
MsgBox(4096,"", "The time is " & @HOUR & ":" & @MIN & ":" & @SEC)
; ==> this end of the file Time.au3
; And put it in the folder "AutoIt3Include" or in the script directory
; Run Script.au3 and see 3 dialog box messages
; One with the current time, one with the text 'Example ', and the last with the current time.
; The contents of the file Time.au3 will be inserted in the file Script.au3 in the specified position

Edited February 8, 2012 by AZJIO

[matwachich]

Juste noticed something in the help file

In the page: Standard Windows Fonts

The OS Names in the table are not visible until you select them.

[guinness]

Thanks, this has been fixed in the latest beta Help file.

[guinness]

AZJIO,

Thanks I'll have a look at your suggestions on the weekend.

[AZJIO]

guinness

Send

Example()
Func Example()
; Simulate the key combination Win + R to open the Run dialogue window.
Send("#r")
; Wait 10 seconds for the Run dialogue window to appear.
$hWnd=WinWait("Run", "", 10)
If Not $hWnd Then Exit
Sleep(100)
; Simulate entering notepad.exe and pressing the 'ENTER' key.
Send("notepad.exe{Enter}")
; Wait 10 seconds for the Notepad window to appear.
Local $hWnd = WinWait("[CLASS:Notepad]", "", 10)
If Not $hWnd Then Exit
; Simulate entering the following string and pressing the 'F5' key to input the date and time into edit control of Notepad.
Send("Today's time/date is {F5}")
Sleep(1500)
; Close the Notepad window using the handle returned by WinWait.
WinClose($hWnd)
; Now a screen will pop up and ask to save the changes, the classname of the window is called
; "#32770" and simulating the "TAB" key to move to the second button in which the "ENTER" is simulated to not "save the file"
WinWaitActive("[CLASS:#32770]")
Sleep(500)
Send("{TAB}{ENTER}")
EndFunc   ;==>Example

SoundSetWaveVolume

SoundSetWaveVolume(50) ; Set Volume
SoundPlay(@WindowsDir & "mediatada.wav",1)
SoundSetWaveVolume(10)
SoundPlay(@WindowsDir & "mediatada.wav",1)

Shutdown

Exit ; Attention, it only for an example.
Shutdown(6) ; Force a reboot

RunWait

Example()
Func Example()
    ; Run Notepad and wait for the Notepad process to close.
    Local $iReturn = RunWait("notepad.exe")
    ; Display the return code of the Notepad process.
    MsgBox(4096, "", "The return code from Notepad was: " & $iReturn)
EndFunc   ;==>Example
Exit
; File Compression "file.dll"  to the archive "file.dl_"
RunWait('makecab.exe "'&@ScriptDir&'file.dll"', '', @SW_HIDE)
RunWait('makecab.exe /D Compress=ON  /D CompressionMemory=21 /D CompressionType=LZX /D CompressionLevel=7 "'&@ScriptDir&'file.txt"', '', @SW_HIDE)
; File Compression "Boot.ini"  to the archive "Archive.7z" with password "My Password"
RunWait(@ProgramFilesDir &'7-Zip7z.exe a "'&@HomeDrive&'Archive.7z" -p"My Password" -mhe -mx9 "'&@HomeDrive&'Boot.ini"', '', @SW_HIDE)
; NTFS-compression (to use a folder /s:path)
RunWait('compact.exe /c /i "'&@MyDocumentsDir&'Readme.txt"', '', @SW_HIDE)
; NTFS-decompression
RunWait('compact.exe /u /i "'&@MyDocumentsDir&'Readme.txt"', '', @SW_HIDE)
; Creates a bootable ISO-file
RunWait(@ScriptDir &'cdimage.exe -l"GrubCD" -g -h -c -j1 -m -b"'&@ScriptDir&'grubldr.bin" "'&@ScriptDir&'sourse" "'&@ScriptDir&'grub_cd.iso"', '', @SW_HIDE)
; Creates a bootable ISO-file
RunWait(@ScriptDir &'mkisofs.exe -duplicates-once -volid "GrubCD" -iso-level 4 -b grldr.bin -no-emul-boot -boot-load-seg 0x1000 -hide boot.catalog -hide grldr.bin -o "'&@ScriptDir&'grub_cd.iso" "'&@ScriptDir&'sourse"', '', @SW_HIDE)
; Mount ISO-file
RunWait('imdisk.exe -a -t file -o ro -m #: -f "'&@ScriptDir&'grub_cd.iso"', '', @SW_HIDE)
; Mount IMG-file
RunWait(@ComSpec & ' /C vdk.exe open 0 '&@ScriptDir&'Boot.img /p:0 /l:Y: | find /v "http:" | find /v "version" | find /v "Failed"', '', @SW_HIDE)
; Emulation boot HDD (Fixed, Removable)
RunWait(@ScriptDir&'qemu.exe -L . -m 512 -hda ".PhysicalDrive0" -boot c')
; Disable the device (network card)
RunWait(@ScriptDir&'devcon disable @PCIVEN_10EC&DEV_8168*', '', @SW_HIDE)
; Enable the device (network card)
RunWait(@ScriptDir&'devcon enable @PCIVEN_10EC&DEV_8168*', '', @SW_HIDE)
; Output to a file
RunWait(@ComSpec & ' /c reg.exe -h>"'&@ScriptDir&'text.txt"', '', @SW_HIDE)

Edited February 9, 2012 by AZJIO

[Valik]

The Shutdown() example is stupid. The example for RunWait() is beyond ludicrously stupid. The point isn't to teach every single possible thing they can do with a function. It's to give a basic usage demonstration.

[AZJIO]

An example is to show all the properties of functions, and still be concise.

1. RunWait does not show the startup parameters

2. Very frequent error-if the key contains the path, it should be quoted

3. Example with @ComSpec and @SW_HIDE

[Valik]

An example is to show all the properties of functions, and still be concise.

I'm completely blown away by that sentence. People accuse me of having an ego yet you try to tell me what an example is supposed to do? Me? The person who's been working on AutoIt since 2004? Me, the current project leader? Just... wow.

Anyway.

No, the examples are not meant to show all properties of functions. That's information overload. Showing every possible permutation on how to invoke a function does more harm than good. If a user doesn't know how to correctly use a function (a reasonable assumption if they are looking at the example) then how are they going to know which of the many examples is the one they need? Furthermore, how are they ever going to learn how to read and interpret the documentation and apply that in the language if they have their hand held through everything? It's far more productive to teach users the basics so get a good foundation and begin to recognizing the patterns on their own. From there they should be able to use the function in other ways without seeing additional examples. Otherwise they are not ready to use the function in other ways because they still lack basic knowledge.

I haven't even touched on the actual calls you're making in the examples. Calls to devcon? In @ScriptDir? That's not going to work, of course, which means you've provided a broken example. Or it won't work because the device ID is different for the user's NIC. Or it will work and disable the user's NIC. What the fuck!? The last one dumps the help text for Registry Editor to a file in @ScriptDir. By default @ScriptDir will be something like "C:\Program Files (x86)\AutoIt3\Examples\" which is protected so you're really sending the output to the Virtual Store.

A million Picards in a million parallel universes just Double-Picard-Facepalmed at the examples you provide.

[wraithdu]

For completeness...