Help File/Documentation Issues. (Discussion Only)

[water]

Fixed.

[JohnOne]

Opened 28 minutes ago
Closed 11 minutes ago

Now that's fucking service!

 

[guinness]

Now that's fucking service!

 

Hmm..would have been quicker, though I don't have svn on this machine.

Edited August 12, 2015 by guinness

[Teks]

https://www.autoitscript.com/autoit3/docs/intro/running.htm#CommandLine

Command Line Parameter Argument

constant variables  constants

 

[Skysnake]

Help File Entry for GUIRegisterMsg

This page from the Help file needs some TLC.  I think the content is good, but the language is a bit clumsy. Please have a look

This is just a sample:

By default after finishing the user function the AutoIt internal message handler will be proceed.
That won't be if your Return a value (See WM_COMMAND in example) or if you use the keyword 'Return' without any value.
By using 'Return' without any return value the AutoIt internal message handler (if there is one for this message) will NOT be proceed!
 

(The Servers says "No")

 

[mLipok]

https://www.autoitscript.com/autoit3/docs/libfunctions/_DateAdd.htm

in parameters description there is:

n - Add/subtract minutes to/from the specified en date

is this any kind of typo ?
I mean here:
 "specified en date"

 

[Melba23]

SkySnake & mLipok,

I agree with both of those - looking into it.

M23

[Skysnake]

Thx

[Melba23]

SkySnake,

How about this:

By default the AutoIt internal message handler (if there is one for that message) will be actioned after the user function exits. The AutoIt internal message handler will also be actioned if the keyword <strong>Return</strong> is used with the constant <strong>$GUI_RUNDEFMSG</strong> (found in GUIConstantsEx.au3).

However, if <strong>Return</strong> is used with any other value (including no value at all) the AutoIt internal message handler will <strong>NOT</strong> be actioned (See WM_COMMAND in example).

So an early return from the user function requires <strong>Return $GUI_RUNDEFMSG</strong> if the AutoIt internal handler for that message is to run (see other examples).

M23

[guinness]

https://www.autoitscript.com/autoit3/docs/intro/running.htm#CommandLine

Command Line Parameter Argument

constant variables  constants

 

No issue.

[JohnOne]

Might not be a big issue but there is ambiguity there.

Can't harm the help file to disambiguate a parameter from an argument.

[Skysnake]

@Melba23

That reads very nicely, thank you very much.

Please note the same text is repeated as comments lower down in the example itself.

 

[LarsJ]

Melba23, In the example for GUIRegisterMsg in function MY_WM_DRAWITEM can you also make this update to make the script run under 64 bit:

;Local $stDrawItem = DllStructCreate("uint;uint;uint;uint;uint;uint;uint;int[4];dword", $lParam)
Local $stDrawItem = DllStructCreate("uint;uint;uint;uint;uint;hwnd;handle;long[4];ulong_ptr", $lParam)

 

[Melba23]

SkySnake & LarsJ,

Thanks - I will amend the example as well.

M23

Edit: And done.

Edited December 2, 2015 by Melba23

[guinness]

Melba23, In the example for GUIRegisterMsg in function MY_WM_DRAWITEM can you also make this update to make the script run under 64 bit:

;Local $stDrawItem = DllStructCreate("uint;uint;uint;uint;uint;uint;uint;int[4];dword", $lParam)
Local $stDrawItem = DllStructCreate("uint;uint;uint;uint;uint;hwnd;handle;long[4];ulong_ptr", $lParam)

 

Sure there is a constant out there for this already?

Edit: Seems https://msdn.microsoft.com/en-us/library/windows/desktop/bb775802(v=vs.85).aspx isn't!

Edited December 2, 2015 by guinness

[guinness]

I am going to re-write GUIRegisterMsg.au3, as a lot of those functions are in the standard library and exhibit no error checking whatsoever. It's also stops the "copy 'n' paste" fiends from ruining their code.

[Teks]

No issue.

No offense, but "constant variable" is an oxymoron. It's either constant or variable. Pick a good book on any mainstream language and see yourself

Here's one https://msdn.microsoft.com/en-us/library/e6w8fe1b.aspx

[JohnOne]

You have a good point

constant variable <-> constant value

[Mat]

No offense, but "constant variable" is an oxymoron. It's either constant or variable. Pick a good book on any mainstream language and see yourself

Here's one https://msdn.microsoft.com/en-us/library/e6w8fe1b.aspx

AutoIt is slightly different, in that our "constants" are variables. They are stored in the same namespace, and are treated almost identically, with the exception they cannot be written to. Mainstream languages, you generally are talking about compiled languages, can actually have constants, that are replaced at compile time.

Simple example:

Global Const $foo = Random()

That's a constant apparently. 

[JohnOne]

I like that autoit can assign a value to a const like that when declared, but it is still a constant value for the lifetime of the script.

The fact that the issue is being discussed still shows there is ambiguity, but if it were to just be disambiguated in the help file, what might the remark be? "a constant variable, is in fact not variable"?

In my view, it's a no brainer.