Amending the FAQ in the help file.

[Melba23]

Quesney,

https://www.autoitscript.com/wiki/Adding_UDFs_to_AutoIt_and_SciTE

M23

[Quesney]

AHhhhh life saver thank you, I was searching the wrong text to locate it thanks so much

[MattHiggs]

Hey.  So I think I may have found a error in the help file.  For function _GUICtrlListBox_GetSelCount, the help file states that if no items are selected, the function will return -1.  However, it appears that it returns the number of selected items in all cases, even if no items are selected (which means it would return 0).  I modified the example script associated with the function so that it would not select any of items in the list, and this was the result:

[BrewManNH]

This belongs in the bug tracker and not in this thread, this thread is about modifying the FAQ in the help file.

[Skysnake]

@BrewManNH, I have also posted on the Help docs thread as I am not allowed onto the bug tracker... @Melba23 knows about that...

Skysnake

[Skysnake]

::/html/functions/GUICtrlCreateEdit.htm

The Help file does NOT mention the #include <EditConstants.au3> required, but it does show up when you open the example...

[Jos]

Why would it need mentioning for this internal function?
The example is using the Include file so do expect it there.

Jos

[Skysnake]

For the simple reason that all other Help file entries list the required #includes.  Also, in the Help file it is not apparent, unless one opens the example.  Uniformity, completeness and accuracy.  I think it was an oversight.

[Jos]

Still missing something here I guess. Isn't it the case that for UDF's the required #Include file is listed and for buildin functions none?

Jos

Edited August 15, 2017 by Jos

[rudi]

help file entry for _ArrayDisplay() should mention _DebugArrayDisplay() and vice versa.

 

Regards, Rudi.

[argumentum]

In regards to _WinAPI_MessageBoxCheck(), the Microsoft info is not true.
at https://docs.microsoft.com/en-us/windows/desktop/api/shlwapi/nf-shlwapi-shmessageboxchecka they say that the value will be stored at:
HKEY_CURRENT_USER\Software\Microsoft\Windows\CurrentVersion\Explorer\LowRegistry\DontShowMeThisDialogAgain
just as in AutoIt help file, but in my Win10 PC is stored at:
HKEY_CURRENT_USER\Software\Microsoft\Windows\CurrentVersion\Explorer\DontShowMeThisDialogAgain
even tho, the other one exists.

...just sharing. 

Edited November 16, 2018 by argumentum
clarify

[argumentum]

in the example of the help file about _Timer_SetTimer(), in  the example, the progress bar leaves no room for the clock to show.

Spoiler

expandcollapse popup

#include <GUIConstantsEx.au3>
#include <GuiStatusBar.au3>
#include <ProgressConstants.au3>
#include <Timers.au3>
#include <WindowsConstants.au3>

Global $g_idMemo, $g_hStatus, $g_idProgress, $g_iPercent = 0, $g_iDirection = 1

_Example_CallBack()

Func _Example_CallBack()
    Local $hGUI, $iTimerProgress, $idChange, $iWait = 10, $idState
    Local $aParts[3] = [55, 280, -1] ; <--- adjust to show the clock

    $hGUI = GUICreate("Timers Using CallBack Function(s)", 400, 320)
    $g_idMemo = GUICtrlCreateEdit("", 2, 32, 396, 226, BitOR($WS_HSCROLL, $WS_VSCROLL))
    GUICtrlSetFont($g_idMemo, 9, 400, 0, "Courier New")
    $idState = GUICtrlCreateButton("Start Progress Bar", 70, 270, 100, 25)
    $idChange = GUICtrlCreateButton("Change", 215, 270, 90, 25)
    GUICtrlSetState($idChange, $GUI_DISABLE)
    $g_hStatus = _GUICtrlStatusBar_Create($hGUI, $aParts)
    _GUICtrlStatusBar_SetText($g_hStatus, "Timers")
    _GUICtrlStatusBar_SetText($g_hStatus, @TAB & @TAB & StringFormat("%02d:%02d:%02d", @HOUR, @MIN, @SEC) & "  ", 2) ; <--- adjust to show the clock prettier
    $g_idProgress = GUICtrlCreateProgress(0, 0, -1, -1, $PBS_SMOOTH)
    GUICtrlSetColor($g_idProgress, 0xff0000)
    _GUICtrlStatusBar_EmbedControl($g_hStatus, 1, GUICtrlGetHandle($g_idProgress))
    GUISetState(@SW_SHOW)

    _Timer_SetTimer($hGUI, 1000, "_UpdateStatusBarClock" ) ; create timer

    While 1
        Switch GUIGetMsg()
            Case $GUI_EVENT_CLOSE
                ExitLoop
            Case $idState
                If GUICtrlRead($idState) = "Start Progress Bar" Then
                    $iTimerProgress = _Timer_SetTimer($hGUI, $iWait, "_UpdateProgressBar") ; create timer
                    If @error Or $iTimerProgress = 0 Then ContinueLoop
                    GUICtrlSetData($idState, "Stop Progress Bar")
                    GUICtrlSetState($idChange, $GUI_ENABLE)
                Else
                    GUICtrlSetState($idChange, $GUI_DISABLE)
                    _Timer_KillTimer($hGUI, $iTimerProgress)
                    GUICtrlSetData($idState, "Start Progress Bar")
                EndIf

            Case $idChange
                If $iWait = 10 Then
                    $iWait = 250
                Else
                    $iWait = 10
                EndIf
                MemoWrite("Timer for _UpdateProgressBar set at: " & $iWait & " milliseconds")
                $iTimerProgress = _Timer_SetTimer($hGUI, $iWait, "", $iTimerProgress) ; reuse timer with different interval
        EndSwitch
    WEnd
    ConsoleWrite("Killed All Timers? " & _Timer_KillAllTimers($hGUI) & @CRLF) ; must be True as the timer to "_UpdateStatusBarClock" have not been killed
    GUIDelete()
EndFunc   ;==>_Example_CallBack

; call back function
Func _UpdateStatusBarClock($hWnd, $iMsg, $iIDTimer, $iTime)
    #forceref $hWnd, $iMsg, $iIDTimer, $iTime
    _GUICtrlStatusBar_SetText($g_hStatus, @TAB & @TAB & StringFormat("%02d:%02d:%02d", @HOUR, @MIN, @SEC) & "  ", 2) ; <--- adjust to show the clock prettier
EndFunc   ;==>_UpdateStatusBarClock

; call back function
Func _UpdateProgressBar($hWnd, $iMsg, $iIDTimer, $iTime)
    #forceref $hWnd, $iMsg, $iIDTimer, $iTime
    $g_iPercent += 5 * $g_iDirection
    GUICtrlSetData($g_idProgress, $g_iPercent)
    If $g_iPercent = 100 Or $g_iPercent = 0 Then $g_iDirection *= -1
    If $g_iPercent = 100 Then
        GUICtrlSetColor($g_idProgress, 0xff0000)
    ElseIf $g_iPercent = 0 Then
        GUICtrlSetColor($g_idProgress, 0x0000ff)
    EndIf
EndFunc   ;==>_UpdateProgressBar

; Write a line to the memo control
Func MemoWrite($sMessage)
    GUICtrlSetData($g_idMemo, $sMessage & @CRLF, 1)
EndFunc   ;==>MemoWrite

 

..I added notes to the code where I made changes.

Edited December 3, 2018 by argumentum

[Inpho]

More of a peeve than anything else; I'd describe this as Melba probably would - a lesson for the student.

The function correctly states that it returns either a string or an array:
_GUICtrlListView_GetSelectedIndices()

And this function correctly states that it accepts an input type of Integer (as the required parameter is formatted as $iIndex):
_GUICtrlListView_GetItemText()

It took me an embarassing amount of time to realise that the returned string from the GetSelectedIndices() needs to be converted to a number before it can be used in GetItemText()

Example to demonstrate.

expandcollapse popup

#include <GuiListView.au3>
#include <GUIConstants.au3>
#include <GUIConstantsEx.au3>
#include <WindowsConstants.au3>

Global $sString = ""

$hGui = GUICreate('Test', 150, 200)
$hListView = GUICtrlCreateListView("1|2", 10, 10, 130, 123)
$hButton1 = GUICtrlCreateButton("1", 10, 135)
$hButton2 = GUICtrlCreateButton("2", 10, 165)

For $i = 1 To 5
    GUICtrlCreateListViewItem("a|b", $hListView)
Next

GUISetState()

While True
    Switch GUIGetMsg()
        Case -3
            Exit
        Case $hButton1
            $sString = ""
            $iSelected = _GUICtrlListView_GetSelectedIndices($hListView)
            If $iSelected = "" Then
                MsgBox(0, "Error", "You must select something", 0, $hGui)
                ContinueLoop
            EndIf
            $sString = _GUICtrlListView_GetItemText($hListView, $iSelected)
            ConsoleWrite($sString & @CRLF)
        Case $hButton2
            $sString = ""
            $iSelected = _GUICtrlListView_GetSelectedIndices($hListView)
            If $iSelected = "" Then
                MsgBox(0, "Error", "You must select something", 0, $hGui)
                ContinueLoop
            EndIf
            $sString = _GUICtrlListView_GetItemText($hListView, Number($iSelected))
            ConsoleWrite($sString & @CRLF)
    EndSwitch
WEnd

Imo this something that the help file should inform the user about, what you say?

[jchd]

Why? _GUICtrlListView_GetItemText() clearly states that the index is expected in integer format.
You choose to obtain selected index (or indices) as string, thus it's your responsability to perform the conversion.

[Inpho]

I don't think it's a big bother in itself; it's just the inconsistency across functions. There are other functions which state that they require an integer, but if you feed them a string, the function does the conversion (or the function doesn't fail at least). ArrayColDelete comes to mind. 

I guess if a user doesn't know which functions will automatically convert datatypes, the lesson is to always convert yourself.

[jchd]

Observe that the function mention Indices (a plural). When more than one item index are selected, the string returned contains a series on numeric indices separated by |. It's up to you the user to decide which index to feed to other functions, so you have to extract the index you want (each in turn if needed) and perform the conversion.

[Skysnake]

Helpfile

ChrW

Returns a character corresponding to a unicode code.

ChrW ( UNICODEcode )

Request for inclusion of an additional example:

I used this

ChrW ( 0xA0 ) ; hex for non-breaking space

 

[jchd]

1 hour ago, Skysnake said:

Request for inclusion of an additional example:

I used this

ChrW ( 0xA0 ) ; hex for non-breaking space

 

Maybe it would be more enlightning to examplify a codepoint which is <= 0xFF in Windows Occidental codepage but >= 0x100 in Unicode.
The first example of such is the Euro symbol:

MsgBox(0, "", "Today 1 " & Chr(0x80) & " = 2 " & ChrW(0x20AC))

Because AutoIt strings are using [a subset of] Unicode, Chr(0x80) is interpreted as that value in the Windows codepage (Occidental for me) and internally converted to its Unicode counterpart to be stored as string. We then concat the actual Unicode codepoint to show what happens.

Meanwhile it immediately doubles the savings of users who actually read to the help file!

[Skysnake]

The Help File example is not wrong, but does not show how to use codes in Hex format. All I am asking for is an example that elucidates usage.

 

[jchd]

Correct and by the way we can thusly point out the implied conversion which occurs with Chr(), with no additional cost.