Report Help File Issues Here

[Melba23]

guinness,

The line break macro definitions seem a little oddly worded at the moment:

@CR             Carriage return, Chr(13); sometimes used for line breaks. 
@CRLF = @CR & @LF     Occasionally used for line breaks. 
@LF Line feed, Chr(10)    Typically used for line breaks.

They are all very vague (Sometime, occasionally, typically) and do not fit what I have always understood as the normal usage in the common OSs. Perhaps something like the following might be better:

@CR            Carriage return {Chr(13)} - Standard line break in Mac (OS <9) files
@CRLF = @CR & @LF    Standard line break in Windows files
@LF            Line feed {Chr(10)} - standard line break in Linux and Mac OS X+ files

M23

Edit: 14k!

Edited February 11, 2013 by Melba23

[Mat]

Might be worth mentioning the old StringSplit having empty elements gotcha too.

[AZJIO]

_GUICtrlTab_GetItem

_GUICtrlTab_SetItem($hTab, 0, "New Text", BitOR($TCIS_BUTTONPRESSED, $TCIS_BUTTONPRESSED), 2)

$hTab = GUICtrlCreateTab(2, 2, 396, 296, $TCS_BUTTONS)

In WinXP without $TCS_BUTTONS style effect is not visible

_GUICtrlTab_GetItemRectEx

MsgBox(4160, "Information", "Display rectangle: " & $sRect)

Must be repeated as _GUICtrlTab_GetItemRect() function.

_GUICtrlTab_SetItemState

If BitAND($iState, 1) Then $sText &= "Button Pressed" & @LF

If BitAND($iState, 2) Then $sText &= "Button Highlighted"

1 = $TCIS_BUTTONPRESSED

2 = $TCIS_HIGHLIGHTED

Edited February 12, 2013 by AZJIO

[BrewManNH]

Is there any where in the help files that can be pointed to that mentions the fact that using -1 in, for example, "GUICtrlSetFont(-1, 20, 800, Default, "Arial")" points the function GUICtrlSetFont to the last created control? I know that I can do it this way, but I can't for the life of me find it in the help file that says that works the way we know it works.

I haven't had anyone question this practice, but if it ever comes up, I'd like to be able to point to the correct section of the help file that explains it.

[guinness]

I personally don't use -1 anymore unless I have to (debugging reason,) but it does lead me to wonder how I learnt this?! If it were to be added, where would that be please?

Edit: And I would say using Default is more appropriate than -1.

Edited February 12, 2013 by guinness

[BrewManNH]

I think using Default in its place would be even more confusing, although it does work correctly.

As to where to put it, I honestly have no clue where it would fit. Maybe a new FAQ.

[guinness]

I tried to draw interest to creating a new FAQ, but it received little response to what I had hoped.

[BrewManNH]

I personally don't use -1 anymore unless I have to (debugging reason,) but it does lead me to wonder how I learnt this?!

Most of the help file's example scripts use -1 to refer back to the previously created control. I've also seen discussion on the forums about it, but nothing recently, where someone used -1 and another user asked about it, but I've never been able to find it documented. And as we know, if it's not documented, it's able to be changed at any time.

[AZJIO]

BrewManNH,

AutoIt -> Function Reference -> Function Notes

When an optional parameter needs to be defined and is preceded by one or more optional parameters, the default value must be given. This may be "" for a string parameter and -1 for other types. Some functions like StringInStr or StringReplace require 0. See the corresponding optional parameter description.

[guinness]

Thanks AZJIO, that should mention the Default keyword.

[BrewManNH]

Unfortunately, that references only a function's optional values, it doesn't reference control IDs or handles which are almost always required, and it doesn't reference that the previously created control can be back-referenced using -1. I'm pretty sure that I found out about it from the help file examples, and from posts on this forum that mentioned it. IMHO it still needs documentation somewhere that -1, in place of a control ID or handle, refers to the previously created one.

[guinness]

You realise that will be a massive task so help would be much appreciated. I'm also not convinced if this was intended by the Devs as it's not documented about the use of -1.

Edited February 12, 2013 by guinness

[BrewManNH]

Well, it could be added to the Function reference notes. That way if anyone looks for it, it will at least be somewhere, and it shouldn't take more than a sentence in that section.

[Mat]

-1 has been a feature of the language longer than I've been here, I don't think its going to be changed.

I think you just do a Find+Replace and change:

The control identifier (controlID) as returned by a GUICtrlCreate... function.

To

The control identifier (controlID) as returned by a GUICtrlCreate... function, or -1 for the last created control.

Edit: And its definitely intentional. That doesn't happen magically, the devs have a variable somewhere storing the last created control id (which they probably need anyway for allocating the next one).

Edited February 12, 2013 by Mat

[guinness]

Not all are formatted like that though, especially the UDFs which can accept -1 as well. It's easier said than done, took me about 2/3 hours just to ensure the UDFs mentioned that a controlid or handle could be passed as a hWnd parameter. Not to mention that not all the UDFs can accept controlids e.g. _GUICtrlListView_Create.

[Mat]

e.g. _GUICtrlListView_Create.

Bad example

[guinness]

OK, if I just did a global search and replace then that entry would have been wrong.

Edited February 12, 2013 by guinness

[AZJIO]

If to stipulate all clauses in the description of each function, it will complicate the general perception of information.

Edited February 12, 2013 by AZJIO

[Mat]

Guinness, I've committed it for the standard functions (r7640), feel free to undo it if you want.

I'm going to have a look at the UDF functions, and see if there is an easier way. I suspect the only way to really know is to check whether control ids are allowed is by looking at the function body for "If IsHWnd($hWnd) Then".

[AZJIO]

AutoIt -> Language Reference -> Variables

Before you can start using Arrays in your script, you must define their bounds using the 'Dim' keyword.

Description of an array can be done on a separate page. In the current version does not show more than a two-dimensional array.