Help File/Documentation Issues. (Discussion Only)

[JockoDundee]

2 hours ago, seadoggie01 said:

There isn't output listed anywhere, you have to run the programs  (I get it though, I looked for it too)

Do you know if that’s by design or?

As in, if we make it so people download the examples to get an answer, then maybe they’ll just keep going and write the program.

On the other hand, there are some people myself included, who just read them sequentially, hoping to create that vague sense of “I think there is a function that does x...”, which can be helpful.  I worked with a guy who studied all the error codes for Oracle without having a problem in front of him - now that’s going too far.

I’m assuming it’s on purpose though, because I know people can modify the help, and I’m sure people would volunteer, and yet there still is not even one output AFAIK.

Edited December 11, 2020 by JockoDundee

[argumentum]

.. it'll nice to replace the _GUICtrlMenu_CreateMenu() example with the one in this help request, as it is more illuminating ( in my view   )

Edit: I opened a ticket to that regard

Edited February 11, 2021 by argumentum
opened a ticket

[mLipok]

As you know I'm not English native speaker.

But I want to ask about this documentation:

Quote

StringStripWS

Strips the white spaces in a string.

StringStripWS ( "string", flag )

Parameters

string

The string to strip.

flag

Flag to indicate the type of stripping that should be performed (add the flags together for multiple operations):     $STR_STRIPLEADING (1) = strip leading white spaces     $STR_STRIPTRAILING (2) = strip trailing white spaces     $STR_STRIPSPACES (4) = strip double (or more) white spaces between words     $STR_STRIPALL (8) = strip all white spaces (over-rides all other flags) Constants are defined in StringConstants.au3.

Return Value

Returns the new string stripped of the requested white spaces.

 

Remarks

 

White spaces includes Chr(9) thru Chr(13) which are HorizontalTab, LineFeed, VerticalTab, FormFeed, and CarriageReturn. White spaces also includes the null string ( Chr(0) ) and the standard space ( Chr(32) ).

To strip single spaces between words, use the function StringReplace().

 

in few places I added "s" and "white"     
and also   changed      "Whitespace"   >>>   "White spaces"

Please correct me if my understanding of English in this specific case is correct.

 

Edited March 1, 2021 by mLipok

[Jos]

I think it is "Whitespace" or space , not "white space".  
https://en.wikipedia.org/wiki/White_space

 

[argumentum]

.... blank space ? I use High Contrast and is dark. The white space between words is black for me.
Maybe we can be a first in correcting the expression.
In any case the concept is spacing between words in reference to writing. Even blank is french for white. Is all concepts.
I guess that if the living language was expressed as such while writing the help file, is quite likely to be the most expressive for those of that tongue.
But a good question nonetheless.  

[Musashi]

3 hours ago, mLipok said:

Please correct me if my understanding of English in this specific case is correct.

Since I am not a native speaker of English myself, my interpretation may be incorrect .

2 hours ago, argumentum said:

But a good question nonetheless.  

It is an interesting question, albeit not a top priority one for most users .

3 hours ago, Jos said:

I think it is "Whitespace" or space , not "white space".  

I see it the same way.

Probably we should differ (in mind) between "Whitespace" and "Whitespace character".

Whitespace character = a character, that is part of a specified set - for AutoIt, see Remarks
Whitespace = The occurrence of one or a series of characters from this set (1..n).

@mLipok : That is perhaps the reason for your uncertainty regarding the use of the plural.

Your variation : $STR_STRIPLEADING (1) = strip leading white spaces

AutoIt-Help   :  $STR_STRIPLEADING (1) = strip leading white space

BTW : I guess, the notation "Whitespace" would be the preferable one.

@Jos :

AutoIt-Help : $STR_STRIPALL (8) = strip all spaces (over-rides all other flags)

Wouldn't the following description be more accurate here ? : $STR_STRIPALL (8) = strip all white spaces (over-rides all other flags)

 

[Jos]

15 minutes ago, Musashi said:

Wouldn't the following description be more accurate here ? : $STR_STRIPALL (8) = strip all white spaces (over-rides all other flags)

No, it would have to be one of these to my humble opinion as it includes other than space characters, but I am not a native English speaker either: 

• strip all Whitespace (over-rides all other flags)
• strip all Whitespace characters (over-rides all other flags)

Jos  

Edited March 1, 2021 by Jos

[Musashi]

26 minutes ago, Jos said:

No, it would have to be one of these to my humble opinion as it includes other than space characters, but I am not a native English speaker either: 

• strip all Whitespace (over-rides all other flags)
• strip all Whitespace characters (over-rides all other flags)

Jos  

That's exactly what I meant, so I guess, I phrased it in a misleading way. My objection was, that $STR_STRIPALL (8) = strip all spaces (over-rides all other flags) ist not accurate, because, as you already noted, not only spaces (CHR(32)) are removed, but ALL whitespace characters.

I also prefer the terms all Whitespace or all Whitespace characters  rather than all white spaces .

Anyway, I just wanted to clarify that, but not overdo this topic .

[JockoDundee]

While we’re talking about this page, could someone explain to me why this statement is included:

Quote

To strip single spaces between words, use the function StringReplace().

since $STR_STRIPALL will strip single spaces between words.

[Jos]

because $STR_STRIPALL  also strips the leading & trailing WhiteSpace ...not just between words.   

Edited March 1, 2021 by Jos

[JockoDundee]

sure, but if you just have a string with just single spaces, which is common enough, it works fine.

[mLipok]

1 hour ago, JockoDundee said:

sure, but if you just have a string with just single spaces, which is common enough, it works fine.

Not always.
You must to remember that StringStripWS() strips all whitespace charatcters, not only standard/normal Space character, just like in this following example:

#include <MsgBoxConstants.au3>
#include <StringConstants.au3>

_Example()

Func _Example()
    _Test(@ScriptLineNumber, _
            "XXX" & @CRLF & _
            "   A  12345" _
            )

EndFunc   ;==>_Example

Func _Test($iLine, $sString)
    ConsoleWrite(Binary($sString) & @CRLF)
    $sString = StringStripWS($sString, $STR_STRIPALL)
    ConsoleWrite(Binary($sString) & @CRLF)
    MsgBox($MB_SYSTEMMODAL, 'Line #' & $iLine, "<" & $sString & ">")
    ConsoleWrite(@CRLF)
EndFunc   ;==>_Test

 

Edited March 1, 2021 by mLipok

[mLipok]

3 hours ago, Musashi said:

AutoIt-Help : $STR_STRIPALL (8) = strip all spaces (over-rides all other flags)
Wouldn't the following description be more accurate here ? : $STR_STRIPALL (8) = strip all white spaces (over-rides all other flags)

This was one of my next question from the list .....

but also here:

Quote

$STR_STRIPSPACES (4) = strip double (or more) spaces between words

btw.
When $STR_STRIPSPACES is used, this function do not strip only "between words"

Quote

$STR_STRIPSPACES (4) = strip double (or more) white space characters

Example:

#include <MsgBoxConstants.au3>
#include <StringConstants.au3>

_Example()

Func _Example()
    _Test(@ScriptLineNumber, _
            "XXX" & @CRLF & _
            "   A  12345    " & @CR _
            )

EndFunc   ;==>_Example

Func _Test($iLine, $sString)
    ConsoleWrite(Binary($sString) & @CRLF)
    $sString = StringStripWS($sString, $STR_STRIPSPACES)
    ConsoleWrite(Binary($sString) & @CRLF)
    MsgBox($MB_SYSTEMMODAL, 'Line #' & $iLine, "<" & $sString & ">")
    ConsoleWrite(@CRLF)
EndFunc   ;==>_Test

 

Edited March 1, 2021 by mLipok

[argumentum]

there is no example for _WinAPI_GetParentProcess() or for _WinAPI_GetProcessName(). So maybe this would be a good one:

#include <Debug.au3>
#include <WinAPIProc.au3>
_DebugArrayDisplay(_GetParentProcessTree(), "_GetParentProcessTree", "", 0, Default, "PID|Name|CommandLine")
Func _GetParentProcessTree($iPID = @AutoItPID)
    Local $n, $iParentPID = $iPID, $aList[100][3]
    $aList[0][0] = $iPID
    $aList[0][1] = _WinAPI_GetProcessName($iPID)
    $aList[0][2] = _WinAPI_GetProcessCommandLine($iPID)
    For $n = 1 To 99
        $iParentPID = _WinAPI_GetParentProcess($iParentPID)
        If $iParentPID = 0 Then ExitLoop
        $aList[$n][0] = $iParentPID
        $aList[$n][1] = _WinAPI_GetProcessName($iParentPID)
        $aList[$n][2] = _WinAPI_GetProcessCommandLine($iParentPID)
    Next
    ReDim $aList[$n][3]
    Return $aList
EndFunc   ;==>_GetParentProcessTree

 

Edited March 16, 2021 by argumentum
nicer looking

[jpm]

3 hours ago, argumentum said:

there is no example for _WinAPI_GetParentProcess() or for _WinAPI_GetProcessName(). So maybe this would be a good one:

#include <Debug.au3>
#include <WinAPIProc.au3>
_DebugArrayDisplay(_GetParentProcessTree(), "_GetParentProcessTree", "", 0, Default, "PID|Name|CommandLine")
Func _GetParentProcessTree($iPID = @AutoItPID)
    Local $n, $iParentPID = $iPID, $aList[100][3]
    $aList[0][0] = $iPID
    $aList[0][1] = _WinAPI_GetProcessName($iPID)
    $aList[0][2] = _WinAPI_GetProcessCommandLine($iPID)
    For $n = 1 To 99
        $iParentPID = _WinAPI_GetParentProcess($iParentPID)
        If $iParentPID = 0 Then ExitLoop
        $aList[$n][0] = $iParentPID
        $aList[$n][1] = _WinAPI_GetProcessName($iParentPID)
        $aList[$n][2] = _WinAPI_GetProcessCommandLine($iParentPID)
    Next
    ReDim $aList[$n][3]
    Return $aList
EndFunc   ;==>_GetParentProcessTree

 

Thanks

I include it in the doc

Cheers

[pixelsearch]

Hi everybody
Sorry for this basic question but AutoIt help file stipulates (topic GUIRegisterMsg) :

Warning: blocking of running user functions which executes window messages with commands such as "MsgBox()" can lead to unexpected behavior, the return to the system should be as fast as possible !!!

But in the example of this same topic, there's a huge MsgBox() in the middle of Func WM_COMMAND() and the GUI will stay responsive no matter how many times we'll click later on the buttons in the GUI.

Could anyone please explain why this MsgBox() doesn't create issues in the example ?
Thanks

[argumentum]

23 minutes ago, pixelsearch said:

Could anyone please explain why this MsgBox() doesn't create issues in the example ?

; React on a button click
Func WM_COMMAND($hWnd, $iMsg, $wParam, $lParam)
    ConsoleWrite('+ Func WM_COMMAND(' & $hWnd & ', ' & $iMsg & ', ' & $wParam & ', ' & $lParam & ')' & @CRLF) ; <<<< add this
    Local $nNotifyCode = _WinAPI_HiWord($wParam)
    Local $iId = _WinAPI_LoWord($wParam)
    Local $hCtrl = $lParam

    If $iId <> 2 And $nNotifyCode = 0 Then ; Check for IDCANCEL - 2
        ; Ownerdrawn buttons do not send a message when pressing ENTER
        ; So if IDOK - 1 comes up, now check for the control that has the current focus
        If $iId = 1 Then
            Local $hFocus = _WinAPI_GetFocus()
            Local $idControl = _WinAPI_GetDlgCtrlId($hFocus)
            PostButtonClick($hWnd, $idControl)
        Else
;~          MsgBox($MB_SYSTEMMODAL, "WM_COMMAND", "GUIHWnd" & @TAB & ":" & $hWnd & @CRLF & _ ; <<<< comment this out

...hope that shows why is not blocking or important for the example  

[pixelsearch]

Thanks argumentum, it's clearer now

* If the registered function doesn't execute windows messages "non-stop", then we're allowed to place a MsgBox in it. It's what you showed with your ConsoleWrite() which is executed only once (or twice) each time in this Func WM_COMMAND, using mostly these notifications codes in the Hi-word part of wparam :

BN_CLICKED    0
BN_SETFOCUS   6
BN_KILLFOCUS  7

* But if the function executes windows messages constantly (for example WM_NOTIFY when we're inside a ListView), then it's another story and MsgBox() should be totally avoided in this case.

[Melba23]

pixelsearch,

I think that is a very good summation of the situation - but I still believe that the Help file should remain as it currently reads because inexperienced users will almost certainly not understand what is happening in each specific case and wonder why their script locks up.

M23and 

[Nine]

_FileCountLines should say that it allows File handle AND Path and filename.  It seems that the code was changed "recently" to use FileReadToArray.