Report Help File Issues Here

[guinness]

Would we use this thread to report errors in the Beta help file? Because I found an error in the 3.3.7.22 beta help file and wasn't sure where to post it.

In the remarks for the Number function - "If input value after conversation fits 32bit" that should be conversion.

Yes, this is the correct thread, as outlined I've updated the issue you reported. Thank you.

[water]

Maybe I'm just blind (probability > 50%) or is the link from the online help file to the UDF help file missing?

[GEOSoft]

It's not there and the online help file version is also outdated.

[Valik]

Only stable documentation is uploaded so it could be fixed... or maybe not.

[GEOSoft]

I thought 3.3.6.1 was the last stable docs; not 3.3.6.0. Not that it's going to matter for more than a few days.

[Valik]

The documentation isn't automatically uploaded so perhaps Jon forgot to update it with 3.3.6.1.

[water]

I would like to see the online help file with the newest production version plus a link to the UDF docu (if time permits).

[guinness]

The libfunctions.htm is still not listed on the index page but you can see the file by searching for 'User Defined Function Reference.'

By the looks of things the Help file wasn't changed a whole great deal between V3.3.6.0 & V3.3.6.1, hence why it probably didn't get updated.

Edited December 11, 2011 by guinness

[BrewManNH]

In the Beta 3.3.7.23 help file, _ArrayUnique, see below:

@error: 0 - No error.

1 - Returns 0 if parameter is not an array.

2 - _ArrayUnique failed for some other reason

3 - Array dimension is invalid, should be an integer greater than 0

The error return for sending the function a variable that's not an array, the description is odd to say the least. The error value is set to 1, not 0.

Edited December 15, 2011 by BrewManNH

[AdmiralAlkex]

In the Beta 3.3.7.23 help file, _ArrayUnique, see below:

The error return for sending the function a variable that's not an array, the description is odd to say the least. The error value is set to 1, not 0.

It doesn't say the error is 0, it says the return is 0 when the error is 1. Which it is.

If Not IsArray($aArray) Then Return SetError(1, 0, 0) ;Check to see if it is valid array

Odd wording, but correct.

[BrewManNH]

It's actually repeating the information from above and could be confusing for a new user. Better wording would be to just say 1 - If parameter is not an array and get rid of the whole Returns 0 part.

Plus the description line at the top is still wrong, it doesn't just return the unique elements of a 1 dimensional array, it works with 2 dimensional arrays as well, but the return array is a 1D array containing all elements, of the dimension checked, with no duplicates, not unique elements. If it were to return the unique elements, it would return all the elements that don't have any duplicates, and throw out any elements that have 1 or more duplicates of them.

Edited December 15, 2011 by BrewManNH

[guinness]

I'm having problems with the Example for GUICtrlCreateObj() as well as correcting it.

[BrewManNH]

Not a major issue with the help file, but the example script for GUISetAccelerators uses Local variable declarations. While those of us that have used AutoIT and understand scope, and know that even when you declare them as local in a global scope they're still global. It might cause newer users to think that using Local in a global scope is normal.

[guinness]

The example is correct, though ideally it should be wrapped around a function. When I first started helping out with changing the Help file this was the first thing I did, changing the scope from Local to Global. Valik pointed out and quite rightly so that despite the variable happening to be Global scope it's Local to the current scope. This is considered bad programming practice otherwise.

[BrewManNH]

What does local to the current scope mean? Because the variables are global in regards to how the example script is written. Isn't the "current scope" the global scope? Curious because it makes little sense that global is local at the same time.

I'm no programmer, and this is all new to me.

[Valik]

It means exactly what it means. Local to the current scope. The current scope may be a function or the global scope (In AutoIt). In languages like C++ it could be local to an If statement or indeed anywhere that brackets ( { } ) appear. One of these days just for shits and giggles I'm going to add in more than two scope levels and you all are going to be fucked because you've been writing shitty scripts with garbage like this:

If $condition Then
    Local $var = "Condition was True"
Else
    Local $var = "Condition was False"
EndIf

; Var will no longer exist in my utopia, this is an error!
ConsoleWrite($var & @CRLF)

With current AutoIt the above code works but is a maintenance problem.

Think about it another way: Do those variables need to be global? If the answer is "no" then they should be declared Local. Note that "Yes they need to be global because they are declared at global scope because the script lacks an entry point-style function" is not an acceptable reason. Global should only be used if a variable truly needs to be Global - that is accessible from more than one function and not passed as a parameter.

Edited December 21, 2011 by Valik

[BrewManNH]

Thank you, that explains it nicely.

Never having done much of anything in any languages other than BASIC style languages and some assembly back in the '80s the concept wasn't clear to me.

[GEOSoft]

No.

Although that may apply to ListviewItems ( I didn't check) it does not apply to radio or checkbox controls. It might need a note someplace but the current text is valid.

Edited December 21, 2011 by GEOSoft

[rover]

ToolTip() can use an icon handle (16/32 pixel) for optional parameter 5

The icon handle remark for _GUIToolTip_SetTitle() should be added for ToolTip()

[KaFu]

Now that's a really nice finding !

#include <winapi.au3>
For $i = 0 To 200
 $hIcon = _WinAPI_LoadShell32Icon($i)
 ToolTip("Test", 100, 100, "Test", $hIcon)
 Sleep(30)
 _WinAPI_DestroyIcon($hIcon)
Next