Report Help File Issues Here

[Mat]

So I was very confused as to why in my changes to the MSgBox docs I had used MB_ICONHAND when usually I use MB_IConerror... Turns out only MB_ICONHAND is defined in Constants.au3.

I think I might take this chance to add MB_IConerror to the include and use it in the docs instead of ICONHAND.

[AZJIO]

guinness,

I found a total of 17 files, this is not much compared with 2000 files. It is possible even to write it in one line. I remember that I spent 2 hours trying to get that example to work. Then I realized that it is not supported by my system.

I just suggest, and you decide to add or not.

Edited January 16, 2013 by AZJIO

[guinness]

AZJIO, can you point me to the post you're referring to please, as I don't feel like trawling through hundreds of posts. Thanks.

Mat,

I created this in the meantime for those who may be confused as what to use. Let me know if there is an obvious mistake.

expandcollapse popup

#include <Constants.au3>

Local $sInput = InputBox('MsgBoxConstants', 'What is the MsgBox value?')
If @error = 0 Then
    Local $sConstantString = MsgBoxConstants($sInput)
    If $sConstantString Then
        ClipPut($sConstantString)
        MsgBox($MB_SYSTEMMODAL, '', 'Copied the following to the clipboard: ' & $sConstantString)
    Else
        MsgBox($MB_SYSTEMMODAL, '', 'Some error occurred, more than likely you didn''t enter a decimal.')
    EndIf
EndIf

; #FUNCTION# ====================================================================================================================
; Name ..........: MsgBoxConstants
; Description ...: Convert a decimal value for the MsgBox flag parameter to the correct variable constant values.
; Syntax ........: MsgBoxConstants($iValue)
; Parameters ....: $iValue              - An valid decimal value used as the flag parameter for MsgBox.
; Return values .: Success: String containing variable constant values.
;                   Failure: Empty string.
; Author ........: guinness
; ===============================================================================================================================
Func MsgBoxConstants($iValue)
    Local $aValid[18][2] = [[17, 2], _
            [$MB_OKCANCEL, '$MB_OKCANCEL'], _
            [$MB_ABORTRETRYIGNORE, '$MB_ABORTRETRYIGNORE'], _
            [$MB_YESNOCANCEL, '$MB_YESNOCANCEL'], _
            [$MB_YESNO, '$MB_YESNO'], _
            [$MB_RETRYCANCEL, '$MB_RETRYCANCEL'], _
            [$MB_CANCELTRYCONTINUE, '$MB_CANCELTRYCONTINUE'], _
            [$MB_ICONHAND, '$MB_ICONHAND'], _
            [$MB_ICONQUESTION, '$MB_ICONQUESTION'], _
            [$MB_ICONEXCLAMATION, '$MB_ICONEXCLAMATION'], _
            [$MB_ICONASTERISK, '$MB_ICONASTERISK'], _
            [$MB_DEFBUTTON2, '$MB_DEFBUTTON2'], _
            [$MB_DEFBUTTON3, '$MB_DEFBUTTON3'], _
            [$MB_DEFBUTTON4, '$MB_DEFBUTTON4'], _
            [$MB_SYSTEMMODAL, '$MB_SYSTEMMODAL'], _
            [$MB_TASKMODAL, '$MB_TASKMODAL'], _
            [$MB_TOPMOST, '$MB_TOPMOST'], _
            [$MB_RIGHTJUSTIFIED, '$MB_RIGHTJUSTIFIED']]

    Local $sReturn = ''

    If IsInt($iValue) Or IsNumber($iValue) Or StringIsDigit($iValue) Then
        Local $iCount = 0

        $iValue = Int($iValue)
        For $i = 1 To $aValid[0][0]
            If BitAND($iValue, $aValid[$i][0]) Then
                $sReturn &= $aValid[$i][1] & ', '
                $iCount += 1
            EndIf
        Next

        $sReturn = StringTrimRight(StringStripWS($sReturn, 3), 1)
        If $iCount > 1 Then
            $sReturn = 'BitOR(' & $sReturn & ')'
        ElseIf $iCount = 0 Then
            $sReturn = '$MB_OK'
        EndIf
    EndIf
    Return $sReturn
EndFunc   ;==>MsgBoxConstants

Edited January 16, 2013 by guinness

[Mat]

Guiness, please see r7483 of MsgBox.au3 for all the constants, and a few naming changes.

I have done the following:

* $MB_RIGHTJUSTIFIED is renamed to $MB_RIGHT (though kept in Constants.au3 for backwards compatibility).

* All MessageBox constants are now defined as per msdn.

* $MB_ICONHAND, $MB_ICONASTERISK, $MB_ICONEXCLAMATION are no longer mentioned in the helpfile, $MB_IConerror, $MB_ICONWARNING and $MB_ICONINFORMATION are used instead.

Any problems?

[trancexx]

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.

The naming of the constants you are using suggests that AutoIt's MsgBox function wraps MessageBox call directly passing flag parameters. This may, but also may not be true. Internal implementation is irrelevant and considering you can't affect it my position in this case is that you (or anyone outside the dev team) shouldn't be doing documentation changes on built-in functions in this manner. This could create some unnecessary restrictions for future development. I hope you understand what I'm trying to say.

[guinness]

Everything looks fine to me.

[Mat]

The naming of the constants you are using suggests that AutoIt's MsgBox function wraps MessageBox call directly passing flag parameters. This may, but also may not be true. Internal implementation is irrelevant and considering you can't affect it my position in this case is that you (or anyone outside the dev team) shouldn't be doing documentation changes on built-in functions in this manner. This could create some unnecessary restrictions for future development. I hope you understand what I'm trying to say.

Naming changes to constants do fall under what I can do though. So the changes 1 and 3 above can stay (unless you have an issue with them?) .

And you started it Talking about MB_IConerror and MB_IConstop when they weren't even in Constants.au3.

However, you are right, so just ask and I'll backtrack on the new constants added as part of r7483 and r7482.

Edited January 16, 2013 by Mat

[trancexx]

And you started it Talking about MB_IConerror and MB_IConstop when they weren't even in Constants.au3.

My dad is stronger than your dad.

Clearly those constants should be in Constants.au3.

MsgBox help file page should be organized a bit differently then what's the case now after you've added constants. Probably it would better to add new column to each table specifying constants names. And it's also good to add remark that if (other) const variables are used it would be better to use bitwise OR rather than performing simple addition, explaining reasons for that and in general.

Edited January 16, 2013 by trancexx

[guinness]

#2307 - I doubt this is valid, but could someone validate their claims. Thanks.

[Melba23]

guinness,

Complete spherical objects - the current syntax is correct:

#include <GUIConstantsEx.au3>

Global $iCount_1 = 0, $iCount_2 = 0

$hGUI = GUICreate("Test", 500, 500)

$cButton_1 = GUICtrlCreateButton("Test 1", 20, 30, 80, 80)
$cButton_2 = GUICtrlCreateButton("Test 2", 110, 30, 80, 80)

GUISetState()

Sleep(1000)

; Current syntax for button 1 - gives 2 clicks as expected
ControlClick($hGUI, "", $cButton_1, "left", 2, 5, 5)

; Suggested syntax for Button 2 - gives 5 clicks as expected whereas the idiot thinks it should only have 2
ControlClick($hGUI, "", $cButton_2, "left", 5, 5, 2)

While 1
    Switch GUIGetMsg()
        Case $GUI_EVENT_CLOSE
            Exit
        Case $cButton_1
            $iCount_1 += 1
            MsgBox(0, "Button 1", "Clicked " & $iCount_1 & " times")
        Case $cButton_2
            $iCount_2 += 1
            MsgBox(0, "Button 1", "Clicked " & $iCount_2 & " times")
    EndSwitch
WEnd

M23

[guinness]

Thanks Melba23 for testing.

I will let a Dev decide on the fate of that ticket.

[JohnOne]

#2307 - I doubt this is valid, but could someone validate their claims. Thanks.

I have used ControlClick Many times in the past using all parameters, it is my opinion that the claims are invalid.

[BrewManNH]

UDPSend doesn't reference UDPRecv in the related section, UDPRecv doesn't reference UDPSend in the related section in the help file.

[guinness]

UDPSend doesn't reference UDPRecv in the related section, UDPRecv doesn't reference UDPSend in the related section in the help file.

Done.

[kylomas]

The link to PCRE doc in this line of the help file returns HTTP404.

Complete description can be found here

kylomas

[guinness]

That's Jon's domain as that file has moved on the server.

Edited January 20, 2013 by guinness

[JohnOne]

Shutdown()

does not explain optional parameter 2.

[FaridAgl]

GUICtrlCreateDate, Example 3, GUIDelete() missed.

[Mat]

JohnOne, as far as I know it is just a reason code (much like exit). Is there a meaning?

[guinness]

Though I don't see it in the parameters list.