Help File/Documentation Issues. (Discussion Only)

[jecartas]

FireFox,

 

I fixed the GUICtrlUpdatea and reverted the WinList commit because AZJIO's code (which I based my TidyText script on) created that output and not the one he reported.

[JohnOne]

 

FireFox,

 

I fixed the GUICtrlUpdatea and reverted the WinList commit because AZJIO's code (which I based my TidyText script on) created that output and not the one he reported.

Is this a second other account?

If not, please clarify why a new user is fixing stuff.

Edited December 3, 2014 by JohnOne

[gloriatorios]

Hello...

Observed that in some descriptions in the documents, for example, to "FileOpen" and more specifically in the "Related" includes links to not only to the other descriptions, but also to the same, ie "FileOpen".

[Guest]

There is no answer to >my question about _EventLog__Open() in the help file.

I think there should be an answer to this question in the help file.

[BrewManNH]

Why don't you wait to see the answer before asking for it to be included in the help file?

[haijie1223]

the picture is V3.3.13.17,the version V3.3.13.19  have the same error also!

The listed functions have the same error,maybe in other function also,I have not check carefully！

_FileListToArray
_GDIPlus_CustomLineCapGetStrokeCaps
_GDIPlus_BrushGetType
_GDIPlus_LineBrushGetColors
_GDIPlus_LineBrushGetRect
_GDIPlus_GraphicsGetCompositingQuality
_GDIPlus_GraphicsGetSmoothingMode
_GDIPlus_MatrixGetElements
_GDIPlus_Decoders
_GDIPlus_Encoders
_GDIPlus_ImageGetFlags
_GDIPlus_ImageGetRawFormat

[mLipok]

I see you are using HelpFile for  3.3.13.17 try to use the latest one I mean  3.3.3.19

[AZJIO]

https://www.autoitscript.com/autoit3/docs/functions/
If you add the index.htm file in the folder, you will see a list of functions
https://www.autoitscript.com/autoit3/docs/functions/index.htm
 
https://www.autoitscript.com/autoit3/docs/functions.htm -> copy to -> https://www.autoitscript.com/autoit3/docs/functions/index.htm
 
fix the file by removing part of the path in the list
<td><a href="functions/Abs.htm">Abs</a></td>
<td><a href="Abs.htm">Abs</a></td>
 
do the same thing to UDF
https://www.autoitscript.com/autoit3/docs/libfunctions

You can also manually make the page "by sections". See an example:

http://azjio.narod.ru/autoit3_docs/libfunctions2.htm

http://azjio.narod.ru/autoit3_docs/functions2.htm

on each page, you can make a link to the beginning of reference and a link to the list of functions

example

Edited February 8, 2015 by AZJIO

[Guest]

Why don't you wait to see the answer before asking for it to be included in the help file?

 

I never thought about it.

Anyway, I now know the answer.

It also works well also in non-english operating system too.

However, I think it works well as a result of an accident...

 

Because I tried the code in >#5 with every other possible string (instead of "Application") that is not exists in the event log  and it worked -

It printed data from the Application category. So even that it didn't found the Application Category according to string (It could not find this category according to a string because I wrote something that does not exist), It was still able to access to this category.

Try it yourself:

#include <EventLog.au3>
#include <Array.au3>

Local $hEventLog = _EventLog__Open('', 'blablabla') ; <- Category that does not exist
If $hEventLog = 0 Then
    ConsoleWrite('Error 1'&@CRLF)
    Exit
EndIf

Local $aEvent = _EventLog__Read($hEventLog, True, False) ; read last event
If Not $aEvent[0] Then
    ConsoleWrite('Error 2'&@CRLF)
    Exit
EndIf

ConsoleWrite('No Error'&@CRLF&@CRLF)
PrintEventData($aEvent)




Func PrintEventData($aEvent)
    ConsoleWrite("Result [0].........: " & $aEvent[0]&@CRLF)
    ConsoleWrite("Record number [1] .: " & $aEvent[1]&@CRLF)
    ConsoleWrite("Submitted [2] .....: " & $aEvent[2] & " " & $aEvent[3]&@CRLF)
    ConsoleWrite("Generated [4] .....: " & $aEvent[4] & " " & $aEvent[5]&@CRLF)
    ConsoleWrite("Event ID [6] ......: " & $aEvent[6]&@CRLF)
    ConsoleWrite("nType [7] .........: " & $aEvent[7]&@CRLF)
    ConsoleWrite("Type [8] ..........: " & $aEvent[8]&@CRLF)
    ConsoleWrite("Category [9] ......: " & $aEvent[9]&@CRLF)
    ConsoleWrite("Source [10] .......: " & $aEvent[10]&@CRLF)
    ConsoleWrite("Computer [11] .....: " & $aEvent[11]&@CRLF)
    ConsoleWrite("Username [12] .....: " & $aEvent[12]&@CRLF)
    ConsoleWrite("Description [13] ..: " &@CRLF&$aEvent[13]&@CRLF)
    ConsoleWrite(@CRLF & @CRLF & @CRLF)
EndFunc

It will print the last event from Application even if I worte the string 'blablabla'.

So there is a possibility that in german system it will work not because that the string "Application" is valid in german system (Or any other language)

But because that it worked by an accident ..

 

Probably the function knows to load the first category  which is "Application" when it didn't found the category  by the string..

Anyway, at least it works. But for someone else it can still be a problem (if I'm right about that ..)

Edited February 9, 2015 by Guest

[mLipok]

in "GUI Control Styles"

there is such description:

 

$SS_CENTER 0x01 Specifies a simple rectangle and centers the error value text in the rectangle. The control automatically wraps words that extend past the end of a line to the beginning of the next centered line.

 

It is not clear to me why there is talking about "the error value"

Is it any kind of editorial imp ?

EDIT: added link

Edited April 23, 2015 by mLipok

[SCare]

There's another thing I just realized lately - I've relied on AutoIt behavior of zeroing out memory used for DLLStruct's when using DLLStructCreate().  This should probably be documented if its going to remain in future versions, which I believe it should as there are certain scripts I know of that will fail or error-out if this is changed. This of course is only applied to new memory allocations, not to DLLStruct's created with pointers.

[guinness]

Was it documented before? If not then it's your fault for relying on a feature that wasn't documented. Request rejected (unless you can show me the documentation where it states this)

[jaberwacky]

The example for InetGetInfo in the helpfile seems to recommend a practice which seems to be unaccepted on these forums by MVPs, experienced coders, etc.

expandcollapse popup

#include <InetConstants.au3>
#include <MsgBoxConstants.au3>
#include <WinAPIFiles.au3>

Example()

Func Example()
    ; Save the downloaded file to the temporary folder.
    Local $sFilePath = _WinAPI_GetTempFileName(@TempDir)

    ; Download the file in the background with the selected option of 'force a reload from the remote site.'
    Local $hDownload = InetGet("http://www.autoitscript.com/autoit3/files/beta/update.dat", $sFilePath, $INET_FORCERELOAD, $INET_DOWNLOADBACKGROUND)

    ; Wait for the download to complete by monitoring when the 2nd index value of InetGetInfo returns True.
    Do
        Sleep(250)
    Until InetGetInfo($hDownload, $INET_DOWNLOADCOMPLETE)

    ; Retrieve details about the download file.
    Local $aData = InetGetInfo($hDownload)
    If @error Then
        FileDelete($sFilePath)
        Return False ; If an error occurred then return from the function and delete the file.
    EndIf

    ; Close the handle returned by InetGet.
    InetClose($hDownload)

    ; Display details about the downloaded file.
    MsgBox($MB_SYSTEMMODAL, "", "Bytes read: " & $aData[$INET_DOWNLOADREAD] & @CRLF & _ ; Or use 0 instead of the constant.
            "Size: " & $aData[$INET_DOWNLOADSIZE] & @CRLF & _ ; Or use 1 instead of the constant.
            "Complete: " & $aData[$INET_DOWNLOADCOMPLETE] & @CRLF & _ ; Or use 2 instead of the constant.
            "successful: " & $aData[$INET_DOWNLOADSUCCESS] & @CRLF & _ ; Or use 3 instead of the constant.
            "@error: " & $aData[$INET_DOWNLOADERROR] & @CRLF & _ ; Or use 4 instead of the constant.
            "@extended: " & $aData[$INET_DOWNLOADEXTENDED] & @CRLF) ; Or use 5 instead of the constant.

    ; Delete the file.
    FileDelete($sFilePath)
EndFunc   ;==>Example

With these comments being suspect.

; Or use 0 instead of the constant.
; Or use 1 instead of the constant.
; Or use 2 instead of the constant.
; Or use 3 instead of the constant.
; Or use 4 instead of the constant.
; Or use 5 instead of the constant.

Edited June 19, 2015 by jaberwacky

[mLipok]

Good point.

[guinness]

I believe I wrote that example, but am sure those comments aren't my doing. Can't check now, but will fix them on Sunday. If I did do it, then I guess it was the time people were complaining at me about constants this and that.

[RichardL]

In AutoIt Help for Enum

 ; These variables will enumerate from 0 to 3.    

Local Enum $eVar1, $eVar2, $eVar3

[water]

Has been fixed for the next beta.

[guinness]

Also don't forget bug tracker is there for reporting as well

[nitekram]

For me, all the examples are working. I do not understand why I have to create a topic. I offered ready-made examples.

Can you provide link or post of your examples, as they are still missing from the help file.

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

EDIT

I did find this, so I will take a look for examples

.

 

Edited July 7, 2015 by nitekram

[mLipok]

Here:   

https://www.autoitscript.com/autoit3/docs/intro/lang_directives.htm  

is listed #pragma compile 

 

Why the links for this directive goes to:
https://www.autoitscript.com/autoit3/docs/directives/pragma-compile.htm

instead:
https://www.autoitscript.com/autoit3/docs/keywords/pragma.htm

 

this is quite different behavior compared to all other directives listed here:
https://www.autoitscript.com/autoit3/docs/intro/lang_directives.htm

 

EDIT: By the way, in this way, the person reading the documentation is not redirected to the full range of knowledge.

Edited July 11, 2015 by mLipok
wording