Help File/Documentation Issues. (Discussion Only)

[jchd]

See AutoIt Const as unmutable variables (once initialized), at least for some definition of "unmutable".

[Skysnake]

_GUICtrlListView_HideColumn description in the Help file on page html/libfunctions/_GUICtrlListView_HideColumn, needs some TLC.  It lack the explanations common on similar pages such as "0 based column array of the LV" etc...

Perhaps add something like this.

Define the column as usual, then hide.

The first column is often used with extended style options, such as tick boxes, and when hidden, these will be hidden as well.

Edited January 21, 2016 by Skysnake

[Skysnake]

_WinAPI_DrawBitmap

This page in the Help file 

::/html/libfunctions/_WinAPI_DrawBitMap.

$iX	Specifies the logical x-coordinate of the upper-left corner of the bitmap.
$iY	Specifies the logical y-coordinate of the upper-left corner of the bitmap.

 

Can BOTH variables point to the same position?  Perhaps a copy & paste fiend has been on the lose?  

[Melba23]

Skysnake,

Quote

Can BOTH variables point to the same position?

Of course - the point has 2 coordinates (x & y) and so needs the 2 parameters to define it.

M23

[mLipok]

in AutoIt Window Information Tool 

I see such a statement:

Quote

• Color of the pixels underneath the mouse pointer
• Details of the Control underneath the mouse pointer

What's mean "underneath" ?

 

 

EDIT:
also in Send description 

Quote

N.B. Windows does not allow the simulation of the "CTRL-ALT-DEL" combination!

What's mean "N.B."

 

Edited February 8, 2016 by mLipok

[Mat]

I mean, how would you describe the control the the cursor is hovering *over* other than being underneath? 

NB is common english, meaning Nota Bene (Note well as a direct translation) which just means to pay special attention to.

[mLipok]

"underneath" thanks for clarification.

"Nota Bene" is also common in polish language (possible that the origin of the word is from the Latin, which is why in Europe is quite common) , but abbreviation N.B. is not.
I think this would be good if It was not used as an abbreviated form, but in the full verbal form.

 

[JohnOne]

Unfortunately, most English speaking English and Americans would not have a clue what it meant.

[jpm]

19 minutes ago, JohnOne said:

Unfortunately, most English speaking English and Americans would not have a clue what it meant.

certainly a Birmingham idiomatic, as Jon is the only designer of this tool ...

[BigDaddyO]

The GUISetAccelerators help file should include a note that if you set this to a ControlID that is inside a TabItem, then it will only be kicked off when the TabItem containing the Control is the active tab.

This had me stumped for a while today and I had to get around it by creating a dummy control outside the tab structure and point the Tab Item control ID and the Dummy Control to the same function.

example of the problem, if you switch to the No Button Tab, then hit Ctrl+y it will not kick off.  switch to the Yes button tab and hit Ctrl+y again and it works.

expandcollapse popup

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

Example()

Func Example()
    GUICreate("Custom MsgBox", 225, 120)

    GUICtrlCreateLabel("Please select a button.", 10, 10, 205, 20)
    GUICtrlCreateTab(5, 30, 215, 85)

    GUICtrlCreateTabItem("Yes Button")
    Local $idYes = GUICtrlCreateButton("Yes", 10, 60, 65, 25)

    GUICtrlCreateTabItem("No Button")
    Local $idNo = GUICtrlCreateButton("No", 80, 60, 65, 25)

    GUICtrlCreateTabItem("Exit Button")
    Local $idExit = GUICtrlCreateButton("Exit", 150, 60, 65, 25)

    GUICtrlCreateTabItem("")

    ; Set GUIAccelerators for the button controlIDs, these being Ctrl + y and Ctrl + n
    Local $aAccelKeys[2][2] = [["^y", $idYes], ["^n", $idNo]]
    GUISetAccelerators($aAccelKeys)

    GUISetState(@SW_SHOW) ; Display the GUI.

    While 1
        Switch GUIGetMsg()
            Case $GUI_EVENT_CLOSE
                MsgBox($MB_SYSTEMMODAL, "You selected", "Close")
                ExitLoop

            Case $idYes
                MsgBox($MB_SYSTEMMODAL, "You selected", "Yes") ; Displays if the button was selected or the hotkey combination Ctrl + y was pressed.

            Case $idNo
                MsgBox($MB_SYSTEMMODAL, "You selected", "No") ; Displays if the button was selected or the hotkey combination Ctrl + n was pressed.

            Case $idExit
                MsgBox($MB_SYSTEMMODAL, "You selected", "Exit")
                ExitLoop

        EndSwitch
    WEnd
    GUIDelete() ; Delete the GUI.
EndFunc   ;==>Example

 

Edited February 10, 2016 by BigDaddyO

[jpm]

For me it is normal as stated by remark #2

The button Yes is not active when Tb NO is selectected

[Skysnake]

auJasperatically

To my amusement I found this still lurking in the online help...

https://www.autoitscript.com/autoit3/docs/intro/lang_variables.htm

 

[guinness]

2 hours ago, Skysnake said:

auJasperatically

To my amusement I found this still lurking in the online help...

https://www.autoitscript.com/autoit3/docs/intro/lang_variables.htm

 

Well it was only fixed a couple months ago in October. So wait until the next release.

[Skysnake]

Thx for the prompt reply

 

[Skysnake]

InputBox

This page in the Help file: /html/functions/InputBox.htm

Contains this in the discussion:

If your script is going to use an inputbox you must include the pragma directive "#pragma compile(inputboxres, true)"

BUT, the pragma page looks like this:

#pragma compile(Out, myProg.exe)
; Uncomment to use the following icon. Make sure the file path is correct and matches the installation of your AutoIt install path.
; #pragma compile(Icon, C:\Program Files\AutoIt3\Icons\au3.ico)
#pragma compile(ExecLevel, highestavailable)

While my AutoIt header looks like this:

#Region **** Directives created by AutoIt3Wrapper_GUI ****
#AutoIt3Wrapper_Icon=script.ico

Note that the Help File InputBox example does not contain a #pragma statement!

1. Is the pragma reference in InputBox Help File page still relevant?

2. (a) Should the reference to pragma be dropped from the InputBox Help File page discussion; or

(b) should a pragma line be added to the example?

 

[argumentum]

Hi.

In the help file, in the RegEnumVal page, about the type of the value, it say:

Success: the requested registry value. @extended is set to the type of the value. 

So I was thinking, after much searching, to have an example more along the lines of:

RegEnumKey_Example("\Microsoft\Windows")
Func RegEnumKey_Example($sThis)
    Local $aRegValueType = ["REG_NONE", "REG_SZ", "REG_EXPAND_SZ", "REG_BINARY", "REG_DWORD_LITTLE_ENDIAN", _
            "REG_DWORD_BIG_ENDIAN", "REG_LINK", "REG_MULTI_SZ", "REG_RESOURCE_LIST", _
            "REG_FULL_RESOURCE_DESCRIPTOR", "REG_RESOURCE_REQUIREMENTS_LIST", "REG_QWORD_LITTLE_ENDIAN"]

    ; X64 running support
    Local $n, $i, $sWow64 = ""
    If @AutoItX64 Then $sWow64 = "\Wow6432Node"
    ConsoleWrite("$sWow64 = " & $sWow64 & @CRLF)
    Local $sVar = ""
    Local $sSubKey = ""
    For $n = 1 To 100
        $sSubKey = RegEnumKey("HKCU\Software" & $sWow64 & $sThis, $n)
        If @error Then ExitLoop
        ConsoleWrite("--- SubKey #" & $n & " for >" & "HKCU\Software" & $sWow64 & $sThis & "< is >" & $sSubKey & "<" & @CRLF)
        For $i = 1 To 100
            $sVar = RegEnumVal("HKCU\Software" & $sWow64 & $sThis & "\" & $sSubKey, $i)
            If @error <> 0 Then ExitLoop
            ConsoleWrite("Value Name  #" & $i & " >" & $sVar & "< - Value Type >" & $aRegValueType[@extended] & "<" & @CRLF)
        Next
    Next
EndFunc   ;==>RegEnumKey_Example

 to have a better idea of what is in @extended

Thanks.

[guinness]

That example looks too complicated to me. It should be made simpler. Also we try not to use ConsoleWrite in examples, as not everyone is using the likes of SciTE to run the examples. Thanks for suggesting though.

Edited June 8, 2016 by guinness

[argumentum]

11 hours ago, guinness said:

example looks too complicated to me

I meant an example more along the lines. So I guess the following could be added as written to the help file: 

#include <MsgBoxConstants.au3>

example()

Func example()

    Local $i, $sVar, $sWow64 = ""
    Local $aRegValueType[12] = ["REG_NONE", "REG_SZ", "REG_EXPAND_SZ", "REG_BINARY", _
            "REG_DWORD_LITTLE_ENDIAN", "REG_DWORD_BIG_ENDIAN", "REG_LINK", _
            "REG_MULTI_SZ", "REG_RESOURCE_LIST", "REG_FULL_RESOURCE_DESCRIPTOR", _
            "REG_RESOURCE_REQUIREMENTS_LIST", "REG_QWORD_LITTLE_ENDIAN"]

    ; X64 running support
    If @AutoItX64 Then $sWow64 = "\Wow6432Node"

    For $i = 1 To 100
        $sVar = RegEnumVal("HKEY_LOCAL_MACHINE\SOFTWARE" & $sWow64 & "\AutoIt v3\AutoIt", $i)
        If @error <> 0 Then ExitLoop
        MsgBox($MB_SYSTEMMODAL, "RegEnumVal example", _
                "Instance # " & $i & " under AutoIt3 key." & @LF & _
                "Value Name: " & $sVar & @LF & _
                "Value Type: " & $aRegValueType[@extended])
    Next

EndFunc   ;==>example

Thanks

Edited June 9, 2016 by argumentum
prettify the example code

[jpm]

59 minutes ago, argumentum said:

I meant an example more along the lines. So I guess the following could be added as written to the help file: 

#include <MsgBoxConstants.au3>

example()

Func example()

    Local $i, $sVar, $sWow64 = ""
    Local $aRegValueType[12] = ["REG_NONE", "REG_SZ", "REG_EXPAND_SZ", "REG_BINARY", _
            "REG_DWORD_LITTLE_ENDIAN", "REG_DWORD_BIG_ENDIAN", "REG_LINK", _
            "REG_MULTI_SZ", "REG_RESOURCE_LIST", "REG_FULL_RESOURCE_DESCRIPTOR", _
            "REG_RESOURCE_REQUIREMENTS_LIST", "REG_QWORD_LITTLE_ENDIAN"]

    ; X64 running support
    If @AutoItX64 Then $sWow64 = "\Wow6432Node"

    For $i = 1 To 100
        $sVar = RegEnumVal("HKEY_LOCAL_MACHINE\SOFTWARE" & $sWow64 & "\AutoIt v3\AutoIt", $i)
        If @error <> 0 Then ExitLoop
        MsgBox($MB_SYSTEMMODAL, "RegEnumVal example", _
                "Instance # " & $i & " under AutoIt3 key." & @LF & _
                "Value Name: " & $sVar & @LF & _
                "Value Type: " & $aRegValueType[@extended])
    Next

EndFunc   ;==>example

Thanks

If you want to stay with the previous example

RegEnumVal.au3

[argumentum]

1 minute ago, jpm said:

If you want to stay with the previous example

thanks but @guinness is right, the example should showcase the function in the simplest possible way.