Help File/Documentation Issues. (Discussion Only)

[AZJIO]

I did a search in the folder "include" and there is a function _WinAPI_PickIconDlg with the same string.
 
GUIGetCursorInfo

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

Global $iInfo

GUICreate("Cursor Info", 420, 300)
$iInfo = GUICtrlCreateLabel('', 10, 10, 150, 72, $WS_BORDER)
GUICtrlCreateEdit("String", 170, 10, 240, 72)
GUICtrlCreateLabel("Label", 10, 90, 400, 40, $WS_BORDER)
GUICtrlCreateButton("Button", 10, 140, 100, 27)
GUISetState()

While 1
    Switch GUIGetMsg()
        Case $GUI_EVENT_MOUSEMOVE
            _MemoWrite()
        Case $GUI_EVENT_CLOSE
            Exit
    EndSwitch
WEnd

Func _MemoWrite()
    Local $aInfo = GUIGetCursorInfo()
    If $aInfo[4] <> $iInfo Then
        GUICtrlSetData($iInfo, _
                '  x = ' & $aInfo[0] & @CRLF & _
                '  y = ' & $aInfo[1] & @CRLF & _
                '  ID = ' & $aInfo[4] & @CRLF & _
                '  Text = ' & GUICtrlRead($aInfo[4]))
    EndIf
EndFunc   ;==>_MemoWrite

Number

MsgBox(0, "Number", Number("0x000009"))

Unexpectedly. Hexadecimal numbers are supported.

 

GUICtrlSetState

Local $iOK = GUICtrlCreateButton("OK", 310, 370, 85, 25)

Why there this line?

 

GUICtrlCreateObj

; ; See also

Edited September 8, 2013 by AZJIO

[mLipok]

All the time I wonder some specifics, naming parameters.

My question is why some of the parameters are called using quotes, and others without such marks,

 

As an example syntax for three functions:

FileSaveDialog ("title", "init dir", "filter" [, options = 0 [, "default name" [, hwnd]]])
ControlCommand ("title", "text", controlID, "command" [, "option"])
WinWait ("title" [, "text" [, timeout = 0]])

 

 

With this function,

FileSaveDialog ("title", "init dir", "filter" [, options = 0 [, "default name" [, hwnd]]])

This is all the more confusing because, for example the "default name"

I think should be described as

FileSaveDialog ("title", "init dir", "filter" [, options = 0 [, default_name = "" [, hwnd]]])

 

Just as in the case of

WinWait ("title" [, "text" [, timeout = 0]])

it should be like this:

WinWait ("title" [, text = "" [, timeout = 0]])

 

 

In general I would suggest that in the naming of the parameter does not use spaces, but instead suggest to use underscores:

so instead of:

FileSaveDialog ("title", "init dir", "filter" [, options = 0 [, "default name" [, hwnd]]])

proposes to adopt such a convention:

FileSaveDialog (title, init_dir, filter [, options = 0 [, default_name = "" [, hwnd]]])

[BrewManNH]

Title, text, init dir, and filter are all strings, you need to enclose strings in quotes. Numbers aren't required to be enclosed in quotes because they're numbers.

[mLipok]

ok

so instead of:

FileSaveDialog ("title", "init dir", "filter" [, options = 0 [, "default name" [, hwnd]]])

such a description :

FileSaveDialog ("title", "init_dir", "filter" [, options = 0 [, "default_name" = "" [, hwnd]]])

 

and

WinWait ("title" [, "text" = "" [, timeout = 0]])

is correct ?

[FireFox]

No,

"text" means that it's the text of the window (parameter named text), and the quotes means that it's a string.

If you want to show the default value it would be:

title [, text = "" [ ...

Br, FireFox.

Edited September 9, 2013 by FireFox

[mLipok]

ok

EDIT: no now it is clear for me

but what about the names of the parameters and the use of spaces / underscores?

 

in the previous examples already showed you what I mean but additionally give you an example:

SplashImageOn ( "title", "file" [, width [, height [, x pos [, y pos [, opt]]]]] )

and the proposal:

SplashImageOn ( "title", "file" [, width [, height [, x_pos [, y_pos [, opt]]]]] )

Edited September 9, 2013 by mlipok

[FireFox]

but what about the names of the parameters and the use of spaces / underscores?

I don't understand.

 

in the previous examples already showed you what I mean but additionally give you an example:

SplashImageOn ( "title", "file" [, width [, height [, x pos [, y pos [, opt]]]]] )

and the proposal:

SplashImageOn ( "title", "file" [, width [, height [, x_pos [, y_pos [, opt]]]]] )

I don't see any difference.

[mLipok]

I don't see any difference.

 

In general I would suggest that in the naming of the parameter does not use spaces, but instead suggest to use underscores:

 

I don't see any difference.

 

x pos >> x_pos

y pos >> y_pos

[guinness]

I would really be careful when suggesting changes to native function documentation.

[mLipok]

So I withdraw my suggestion.

[AZJIO]

If...ElseIf...Else...EndIf

If <expression> Then
    statements
    ...
[ElseIf expression-n Then
    [elseif statements ... ]]
    ...
[Else
    [else statements]
    ...
EndIf

The number of opening and closing brackets do not match.

If <expression> Then

statements

...

[ElseIf <expression-n> Then

[elseif statements ... ]]

...

[Else

[else statements]]

...

EndIf

 

expression
    An expression that returns after calculating True or False
statements
    Block of statements that is executed if the associated expression is True

Remarks

Algorithm is as follows: sequential calculate of expressions <expression> until a expressions is True. Once that happened, he belonging executed the statement block . Otherwise, executed the statement block belonging Else, if it exists. Only one statement block executed and other expressions have not calculated.

_________________________

In the design "For...To...Step...Next, If...ElseIf...Else...EndIf, Switch, Select, While, Do" a parameter "statements", which is missing in the description of the parameters. In my opinion it should be added to as "statements | Block operators"

Edited September 9, 2013 by AZJIO

[jchd]

_StringBetween

Description says: "Find strings between two sets of characters."

This is misleading: $sStart and $sEnd are definitely not character sets, but character sequences, or substrings if you prefer.

Now I'd also like opinions about an issue I see in the behavior of the function itself, when $sStart = $sEnd.

Local $aRes = _StringBetween("abbbaccca", "a", "a")
; "bbb" is between "a" and "a"
; "ccc" is also between "a" and "a" but is not returned
_ArrayDisplay($aRes)

I see that as a bug but I'd like other views.

Edited September 10, 2013 by jchd

[BrewManNH]

It looks like the RegEx being used isn't taking the second a as the start of the search pattern, seeing as how (as I understand it) RE searches a character at a time until it finds the first match, stops when it finds the second match, then starts searching from where it left off +1.

[jchd]

Yes, that's how it currently works. $sEnd ought to be a look-ahead, or am I missing something?

[mLipok]

 

In the design "For...To...Step...Next, If...ElseIf...Else...EndIf, Switch, Select, While, Do" a parameter "statements", which is missing in the description of the parameters. In my opinion it should be added to as "statements | Block operators"

 

 

So far I did not think about the "statement" as a parameter, I still do not think so.

 

I think:

Select ... Case ... EndSelect

 

have a good description of the parameters in the description because it is clearly stated what happens to the "statement".

 

If the expression is true The Following statements up to the next Case or EndSelect statement are executed.
If more than one of the Case statements are true, only the first one is executed.

 

 

I see also good descriptions of these functions:

If ... ElseIf ... Else ... EndIf

Do ... Until

While ... Wend

 

 

 

but I think that, in these functions

For ... In ... Next

Switch ... Case ... EndSwitch

For ... To ... Next Step ...

 

not sufficiently clear indication that what is the relationship between "expression" <> "statement"

 

 

 

and just as the documentation for the function

With ... EndWith

 

How I se about this function AZJIO, did not mention.

 

 

EDIT: "typos, errors"

Edited September 13, 2013 by mlipok

[AZJIO]

mlipok

So far I did not think about the "statement" as a parameter, I still do not think so.

Any element which doesn't belong to a keyword is parameter.

 

have a good description of the parameters in the description because it is clearly stated what happens to the "statement".

This description of function. It isn't the description of this parameter.

 

How I se about this function AZJIO, did not mention.

I left for a snack.

[mLipok]

 

Any element which doesn't belong to a keyword is parameter.

 

so

in Select...Case...EndSelect

in Parameters

there is   "Case <expression>"  

How I think "Case" is a keyword not parameter ?

Am I right, or am I wrong?

This description of function. It isn't the description of this parameter.

 

I mean that:

If the expression is true The Following statements up to the next Case or EndSelect statement are executed.
If more than one of the Case statements are true, only the first one is executed.

This is description to parameter named "Case <expression>" 

 

---

BTW

Select
    Case <expression>
    statement1
    ...
    [Case 
    statement2
    ...]
    [Case Else
    statementN
    ...]
EndSelect

is that right ?

or that one is better ?

Select
    Case <expression 1>
    statement1
    ...
    [Case <expression 2> 
    statement2
    ...]
    [Case Else
    statementN
    ...]
EndSelect

Edited September 13, 2013 by mlipok

[AZJIO]

BTW

I think it is broken. It used to be right.

<b>Case</b> &lt;expression&gt;<br>
<b>Case</b> <expression><br>

special characters are lost

statement to <statement>

How I think "Case" is a keyword not parameter ?

 

Yes (Case = keyword)!

 "Case <expression>"

Free interpretation

Edited September 13, 2013 by AZJIO

[mLipok]

special characters are lost

 

that's beside the point

i asking about   "<expression 2>"

[AZJIO]

I would have done so

Select 
    Case <expression 1>
        <statement 1
        ...>
    [Case <expression n>
        <statement n
        ...>]
    [Case Else
        <else statement
        ...>]
EndSelect

Edited September 13, 2013 by AZJIO