Report Help File Issues Here

[guinness]

Fixed post #76 by AZJIO. Thanks.

[guinness]

Fixed post #62 by AZJIO. Thanks.

[guinness]

For parameter $l_Service the help file states "I dont got a clue what this does".

Fixed. Thanks. I have no comment as to why it was stating this.

[guinness]

I replaced with it

By means of regular expression

$test = StringRegExpReplace($test, '(###rn)(Success:.+?rnFailure:.+?rn)(rn)', '1@@ReturnTable@@' & @CRLF & '2@@End@@' & @CRLF & '3')

Re-done. Due to the nature of how the help files are constructed, this is the correct SRE.

StringRegExpReplace($sRead, '(###\r\n)(Success:)\s*(.+?\r\nFailure:)\s*(.+?\r\n)(\r\n)', '\1' & '@@ReturnTable@@' & @CRLF & '\2' & @TAB & '\3' & @TAB & '\4@@End@@' & @CRLF & '\5')

[guinness]

_GUICtrlHeader_GetOrderArray, _GUICtrlHeader_SetOrderArray

Corrected Example

expandcollapse popup

#include <GUIConstantsEx.au3>
#include <GuiHeader.au3>

$Debug_HDR = False ; Check ClassName being passed to functions, set to True and use a handle to another control to see it work

Global $iMemo

_Main()

Func _Main()
    Local $hGUI, $hHeader, $aOrder[5] = [4, 3, 1, 2, 0]

    ; Create GUI
    $hGUI = GUICreate("Header", 400, 300)
    $hHeader = _GUICtrlHeader_Create($hGUI)
    $iMemo = GUICtrlCreateEdit("", 2, 24, 396, 274, 0)
    GUICtrlSetFont($iMemo, 9, 400, 0, "Courier New")
    GUISetState()

    ; Add columns
    _GUICtrlHeader_AddItem($hHeader, "Column 1", 100)
    _GUICtrlHeader_AddItem($hHeader, "Column 2", 100)
    _GUICtrlHeader_AddItem($hHeader, "Column 3", 100)
    _GUICtrlHeader_AddItem($hHeader, "Column 4", 100)

    ; Set order array
    _GUICtrlHeader_SetOrderArray($hHeader, $aOrder)

    ; Show order array
    $aOrder = _GUICtrlHeader_GetOrderArray($hHeader)
    For $iI = 1 To $aOrder[0]
        MemoWrite("Index: " & $iI-1 & ", Order: " & $aOrder[$iI] & ' (' & _GUICtrlHeader_GetItemText ($hHeader, $iI-1) & ')')
    Next

    ; Loop until user exits
    Do
    Until GUIGetMsg() = $GUI_EVENT_CLOSE
EndFunc   ;==>_Main

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

In all the examples (_GUICtrlHeader_...) you need to add support for Unicode. Otherwise, the column names are not displayed.

_GUICtrlHeader_SetUnicodeFormat ($hHeader, True)

_GUICtrlHeader_GetItemAlign, _GUICtrlHeader_SetItemAlign, _GUICtrlHeader_GetItemFormat, _GUICtrlHeader_SetItemFormat

; Reset column

; Set column

Fixed everything apart from adding _GUICtrlHeader_SetUnicodeFormat, as they display for me.

[guinness]

All issues reported (unless stated otherwise) have been fixed. If I haven't commented/quoted about your issue, please draw my attention to it. Thanks.

Edited January 15, 2013 by guinness

[BrewManNH]

Users of magic numbers will be shot. My new years resolution has become the complete abolition of magic numbers in the helpfile, and I'm merging a lot of the changes needed to do that already.

People using MsgBox(0, ...), which is probably everyone, you are going to have to change your ways.

Here's something to think about for your New Year's resolution. There are approximately 1600 help file example scripts (AutoitDirExamplesHelpFile) which contain the code "MsgBox(4096" instead of using "MsgBox($MB_SYSTEMMODAL" to eliminate the use of the "magic number" 4096. If they should be changed, how would I go about submitting the corrected versions? I don't have SVN access, and don't know how to use versioning anyways, so granting me access wouldn't do anyone much good at this point in time.

[guinness]

Granted, editing those files would help a great deal for Mat and myself, but considering a massive number of changes have taken place since V3.3.8.1 and/or the beta, any effort would be wasted on your part I'm afraid. Thus, editing SVN is always recommended for mammoth tasks such as this.

To answer your question though, I would do it like this:

1. Grab a list of all the .au3 files.

2. Read the file.

3. Parse the file using a regular expression to convert MsgBox(4096, to MsgBox($MB_SYSTEMMODAL,

4. Check whether the include file for that particular constant is available and if not add to the top of the script accordingly.

5. Write back to the original file.

I had zero knowledge of subversion control too, but with access and the willingness to learn has brought me this far with it. Even to the point that I now have a local repository for my scripts and snippets.

[BrewManNH]

The help file examples in the latest beta have the same issue, and that is only one of the places I found where a documented number is being used in place of a constant. Every example of FileOpen that uses a number, for the mode in which to open the file in, is using a magic number instead of a predefined constant which does exist in one of the Constants files. There's probably a lot of places in the UDFs where they're using the file constants, but the help file examples rarely if ever do.

[guinness]

Mat has fixed the examples for FileOpen as well as the documentation, though I don't think he has done so for the examples that may use FileOpen, I will check.

The current beta does not reflect the current state of the help file, SVN does though.

[AZJIO]

guinness,

From the previous topics have been fixed?

_GUICtrlRichEdit_GetSel

an array in the format [, ]

[& lt;low>, & lt;high>]

AutoIt and Developer History

AutoiT3 -> AutoIt3

Became Mod when

Moderator? Hard to translate some phrases.

[guinness]

Fixed AutoiT3 before, but not the others. Thanks.

[Mat]

I'm approaching this from the bottom up, the examples show the symptoms (sort of), it's the fact that these constants aren't even documented that's more concerning.

I'm getting there, one function at a time. After all the constants are documented (and I am also adding a few extra constants) then just about every single example in the helpfile needs to be looked at.

[guinness]

...then just about every single example in the helpfile needs to be looked at.

Well I've manage to tackle about 35-40% of the AutoIt native function so far, but as the saying goes "...many hands make light work." Also not all the examples exhibit good coding practice (in my humble opinion) and hence why I'm trying to change this instead of making only a point about it.

Edit: Before others jump on board slating the help file, don't. It's still an invaluable tool, but like anything in life it can always be improved.

Edited January 15, 2013 by guinness

[AZJIO]

I was looking for the word "Vista" and put the code in the example.

If @OSVersion = "WIN_XP" Then
    MsgBox(4160, "Information", "This function does not work in WinXP")
    Exit
EndIf

[guinness]

Care to elaborate AZJIO? I'm not going to add an example to show how to use @OSVersion as this is showcased throughout the help file.

[Mat]

I was looking for the word "Vista" and put the code in the example.

If @OSVersion = "WIN_XP" Then
    MsgBox(4160, "Information", "This function does not work in WinXP")
    Exit
EndIf

Last chance. I'm ordering the gun from amazon now.

If @OSVersion = "WIN_XP" Then
    MsgBox($MB_SYSTEMMODAL+$MB_ICONASTERISK, "Information", "This function does not work in WinXP")
    Exit
EndIf

[trancexx]

Mat that's not correct. You are giving wrong impression that flags are added one to another. What if someone wants both MB_IConerror and MB_ICONHAND. Maybe even MB_IConstop too?

edit: editor picks up onerror and onstop words as keywords

Edited January 15, 2013 by trancexx

[guinness]

Wouldn't this be more appropriate?

#include <Constants.au3>

MsgBox(BitOR($MB_SYSTEMMODAL, $MB_ICONASTERISK), '', BitOR($MB_SYSTEMMODAL, $MB_ICONASTERISK))

[Mat]

More than happy to do it like that, but already people don't want to use constants, unless you'd like to add bitwise operators

Besides, they shouldn't be using those constants as they aren't all documented in the helpfile.