Help File/Documentation Issues. (Discussion Only)

[guinness]

Fixed. But do me a favour next time and read the first post.

[AZJIO]

msgboxwizard.au3 - need to Switch instead of Select. Add a command button to run the script on the page MsgBox

 

StringCompare

###Description###

Compares two strings lexicographically

###Remarks###

Learn more about see lexigraphically < a class="le" href="../intro/lang_operators.htm" >Operators< /a >, last paragraph. Features in contrast to the "=" operator is that when searching a sorted array even in the absence of coincidence of lines into array it isn't obligatory to check, because position most matches there is a change of sign of the return value.

AutoIt.chm (v3.3.13.2), Black theme

http://rghost.ru/56860880

Edited July 12, 2014 by AZJIO

[JohnOne]

Sleep

Return Value

None.

 

It returns 1.

[Mat]

It returns 1.

I think this has been discussed before. The return value has no significance, and just because it returns 1 right now doesn't mean it will still return 1 next year.  Treat it as an undocumented feature. Use at your own risk, but preferably not at all.

Return value: None, is really just Return Value: Not used. 

[JohnOne]

I understand it may not be used but I don't see why the help file needs to be incorrect, it's such a trivial matter to correct it.

[BrewManNH]

Actually, I've seen the return value used from sleep in a While loop in a few scripts. Instead of using just While 1 and adding a sleep line, I've seen While Sleep(100) used which sleeps the script and keeps the While loop live.

[Mat]

And one day that script will break, for the sake of 4 characters (3 of which are whitespace).

[JohnOne]

I don't see an issue, it returns 1 so the help file should reflect that.

If it gets changed and returns 0 or something else then the help file for that version should reflect that too.

I think if it was a void function internally, then autoit would return 0.

[guinness]

Mat is right.

[JohnOne]

Perhaps, but the help file is wrong.

[mLipok]

Is there anywhere in the HelpFile, is described which functions / statements do not affect the @error and @extended ?

I mean about such case:

SetError(12)
if @error then
    MsgBox(0, 'test1', @error )
Else
    MsgBox(0, 'test2', @error )
EndIf

Previously, I never thought about it.
This time I needed this knowledge, I found I was looking for.
I had a little test it.

But could be a description of the documentation in this regard.

[BrewManNH]

Is there anywhere in the HelpFile, is described which functions / statements do not affect the @error and @extended ?

I mean about such case:

SetError(12)
if @error then
    MsgBox(0, 'test1', @error )
Else
    MsgBox(0, 'test2', @error )
EndIf

Previously, I never thought about it.

This time I needed this knowledge, I found I was looking for.

I had a little test it.

But could be a description of the documentation in this regard.

Which one of those lines are you expecting to set/unset the @error condition? If/Else/Endif are all keywords and not functions, they shouldn't affect @error.

[guinness]

Perhaps, but the help file is wrong.

Please make a trac ticket if you feel it should be fixed.

[mLipok]

Which one of those lines are you expecting to set/unset the @error condition? If/Else/Endif are all keywords and not functions, they shouldn't affect @error.

 

EDIT:

Now I see, that was not related to my post.

Please make a trac ticket if you feel it should be fixed.

 

As I said before (or at least I tried to express it so) I did not expect that "If / Else / Endif" set / unset the @ error condition.

Just before never thought about it.

Not for everyone, it is understood by itself.

This property of language just somewhere in my head existent, but subconsciously.

So I checked HelpFile, to be sure.

I did not find any statements like:

"All keywords, conditionally run statements, and loop statements should not Affect @error"

EDIT: or like this: "Only function affect @error"

Maybe I missed something ?

If indeed there is no such entry in the documentation it really was worth it to add (then I post Track Ticket).

What you think ?

Edited July 23, 2014 by mLipok

[BrewManNH]

Functions affect @error, that's already documented. Keywords and operators don't directly affect @error, and because they're not functions I wouldn't expect them to, but I can't speak about what other people think.

[guinness]

My comment was to JohnOne. As to your issue I believe SetError() pretty much sums it up. No issue.

[mLipok]

My comment was to JohnOne.

 

Oops. Sorry.

 

As to your issue I believe SetError() pretty much sums it up. No issue.

I re read this part of HelpFile ... and I see now what you mean

"When entering a function @error is set to 0. Unless SetError() is called, then @error will remain 0 when the function ends. This means that in order for @error to be set after a function, it must be explicitly set."

 

This means that @error is set ONLY in the two cases:

1

When entering a function

2

When SetError() is used

Edited July 23, 2014 by mLipok

[AZJIO]

1. All words "array" make reference to the description of the array.

2. DirCopy - 

If the result differs from the expected, indicate this in the help file

[careca]

can anyone verify that _GDIPlus_ImageLoadFromFile returns 0 instead of -1 uppon failure as stated in the help file?

[Mat]

can anyone verify that _GDIPlus_ImageLoadFromFile returns 0 instead of -1 uppon failure as stated in the help file?

According to the code it should return zero (it returns a handle so -1 wouldn't make sense). Please raise this as a bug on the trac (BugTracker link at the top of the forum) and it will be fixed when an MVP get's round to it.

Thanks.