Help File/Documentation Issues. (Discussion Only)

[jpm]

Done for next beta

[Werty]

Helpfile/webhelp

_WinAPI_SetWindowDisplayAffinity() is missing an option, $WDA_EXCLUDEFROMCAPTURE

https://learn.microsoft.com/en-us/windows/win32/api/winuser/nf-winuser-setwindowdisplayaffinity

/edit

hmm, appears it's not even included in autoit, the function say it requires atleast win7, but WDA_EXCLUDEFROMCAPTURE requires win10.

Edited November 16, 2024 by Werty

[argumentum]

in https://www.autoitscript.com/forum/topic/131503-shared-folders/#findComment-1541668 I helped the user with where to find the include(s)

Going down the rabbit hole looked at _WinAPI_ShellGetFileInfo() there is no example. Further down found a ticket and modernized it.

#AutoIt3Wrapper_Au3Check_Parameters=-q -d -w 1 -w 2 -w 3 -w 4 -w 5 -w 6 -w 7
#include <StaticConstants.au3>
#include <GUIConstantsEx.au3>
#include <APIShellExConstants.au3>
#include <WinAPIShellEx.au3>
#include <WinAPIIcons.au3>

Example()
Func Example()
    GUICreate("", 128, 128)
    Local $iIcon = GUICtrlCreateIcon("", 0, 48, 48, 32, 32)
    _Icon_Set($iIcon, @ScriptFullPath)
    GUISetState(@SW_SHOW)

    Do
    Until GUIGetMsg() = $GUI_EVENT_CLOSE
    GUIDelete()
EndFunc   ;==>Example

Func _Icon_Clear($iControlID)
    If $iControlID = -1 Then $iControlID = _WinAPI_GetDlgCtrlID(GUICtrlGetHandle($iControlID))
    Return GUICtrlSendMsg($iControlID, $STM_SETIMAGE, $IMAGE_ICON, 0)
EndFunc   ;==>_Icon_Clear

Func _Icon_Set($iControlID, $sFilePath)
    If $iControlID = -1 Then $iControlID = _WinAPI_GetDlgCtrlID(GUICtrlGetHandle($iControlID))
    Local $tInfo = DllStructCreate($tagSHFILEINFO)
    _WinAPI_ShellGetFileInfo($sFilePath, BitOR($SHGFI_ICON, $SHGFI_LARGEICON), 0, $tInfo)
    Local $hIcon = DllStructGetData($tInfo, 'hIcon')
    Return _WinAPI_DestroyIcon(GUICtrlSendMsg($iControlID, $STM_SETIMAGE, $IMAGE_ICON, $hIcon))
EndFunc   ;==>_Icon_Set

and used this script ( above ) because it would complement _WinAPI_DestroyIcon() that is also without an example.

Or add both examples.

Edited March 5 by argumentum

[pixelsearch]

Hi everybody
If I'm not mistaken, there are 2 examples in the help file where an inappropriate structure is created. Though the result is correct, it's a bit confusing. Topics are :

_GUICtrlRichEdit_AutoDetectURL
_GUICtrlRichEdit_GetTextInRange

Here is the incorrect part :

...
_GUICtrlRichEdit_SetEventMask($g_hRichEdit, $ENM_LINK)
...

Func WM_NOTIFY($hWnd, $iMsg, $wParam, $lParam)
    ...
    Case $iCode = $EN_LINK
        $tMsgFilter = DllStructCreate($tagMSGFILTER, $lParam)
        If DllStructGetData($tMsgFilter, "msg") = $WM_LBUTTONUP Then
            $tEnLink = DllStructCreate($tagENLINK, $lParam)
            $iCpMin = DllStructGetData($tEnLink, "cpMin")
            $iCpMax = DllStructGetData($tEnLink, "cpMax")
            MsgBox($MB_SYSTEMMODAL, "", "Invoke your web browser here and point it to " & _
                _GUICtrlRichEdit_GetTextInRange($g_hRichEdit, $iCpMin, $iCpMax))
        EndIf
    ...
EndFunc

The structure $tagMSGFILTER has nothing to do with $EN_LINK . Only $EN_MSGFILTER should use $tagMSGFILTER . Imho both examples should be modified like this :

...
_GUICtrlRichEdit_SetEventMask($g_hRichEdit, $ENM_LINK)
...

Func WM_NOTIFY($hWnd, $iMsg, $wParam, $lParam)
    ...
    Case $iCode = $EN_LINK
        $tEnLink = DllStructCreate($tagENLINK, $lParam)
        If DllStructGetData($tEnLink, "msg") = $WM_LBUTTONUP Then
            $iCpMin = DllStructGetData($tEnLink, "cpMin")
            $iCpMax = DllStructGetData($tEnLink, "cpMax")
            MsgBox($MB_SYSTEMMODAL, "", "Invoke your web browser here and point it to " & _
                _GUICtrlRichEdit_GetTextInRange($g_hRichEdit, $iCpMin, $iCpMax))
        EndIf
    ...
EndFunc

Thanks for reading

 

[jaberwacky]

Edit 1: no, I'm silly ...

Edit 2: Wait ... no, I think this is a mistake after all ... So, in the _GUICtrlEdit_SetTabStops parameters section: Array of tab stops in the following format: [0] - Tab stop 1 [2] - Tab stop 2 [n] - Tab stop n

Edited April 28 by jaberwacky

[Nine]

@jaberwacky You are right.  Doc is mistaken. Also there is a bug in the example of _GUICtrlEdit_SetTabStops.  The icon on the status bar is not showing.

After debugging, the call to DestroyIcon is the culprit, need to make a tracker...

Edited April 28 by Nine

[ioa747]

I don't know if I'm in the right place,
I just discovered in the example C:\Program Files (x86)\AutoIt3\Examples\Helpfile\_Timer_SetTimer.au3

which was an example for:
_Timer_KillAllTimers
_Timer_KillTimer
_Timer_SetTimer

that a line is missing from the example.

$g_hStatus = _GUICtrlStatusBar_Create($hGUI, $aParts)
_GUICtrlStatusBar_SetParts($g_hStatus, $aParts) ; * <-- this line is missing

so that the example also shows the time, as it was designed

 

[pixelsearch]

Hi everybody

_ArrayInsert . Help file (3.3.16.1) stipulates :

Success: the new size of the array.
Failure: 0 and sets the @error flag to non-zero.

This was correct until version 3.3.10.2 (from 2013)
Excerpts from the function (2013)

If Not IsArray($avArray) Then Return SetError(1, 0, 0)
If UBound($avArray, 0) <> 1 Then Return SetError(2, 0, 0)
If $iElement > UBound($avArray) Then Return SetError(3, 0, 0)

Starting with version 3.3.12.0 (from 2014) the return value is always -1 when there is a failure :
Excerpts from the function (2014 to 2025)

If Not IsArray($avArray) Then Return SetError(1, 0, -1)
Return SetError(2, 0, -1)
Return SetError(3, 0, -1)
Return SetError(4, 0, -1)
Return SetError(5, 0, -1)
Return SetError(6, 0, -1)
Return SetError(7, 0, -1)
Return SetError(8, 0, -1)

Could you please be kind to amend the help file, topic _ArrayInsert, to indicate that the Return value is -1 when the function fails?
Thanks

[mLipok]

On 3/5/2025 at 11:45 PM, argumentum said:

Or add both examples.

added: _WinAPI_ShellGetFileInfo.au3
I can't remember how to complete the _WinAPI_DestroyIcon documentation "as a reference to _WinAPI_ShellGetFileInfo.au3"
I hope someone else will complete this soon.

Edited July 6 by mLipok

[guinness]

On 7/6/2025 at 6:25 PM, pixelsearch said:

Could you please be kind to amend the help file, topic _ArrayInsert, to indicate that the Return value is -1 when the function fails?

Excellent find. Fixed

[mLipok]

@guinness Hello my friend

[pixelsearch]

5 hours ago, guinness said:

Excellent find. Fixed

@guinness is here, such great news. Thanks for your incredible participation in AutoIt

Yesterday I found that something important  was also missing in the help file (as stated in this post) . Please let me paste it here as that's the place to be :

15 hours ago, pixelsearch said:

For the record, this line would be a good start in OP's script, placed in the TrayGetMsg loop :

Case $TRAY_EVENT_MOUSEOVER
    ...

It is strange that the help file doesn't mention the event $TRAY_EVENT_MOUSEOVER in the topic TrayGetMsg when it is mentioned in the topic TraySetOnEvent

That's a big difference with the events listed in the help file, topic GUIGetMsg and GUISetOnEvent : the same events are listed in these 2 topics.

Thanks if you can fix it too.

Edited July 11 by pixelsearch

[guinness]

Thanks @pixelsearch. Indeed I double checked and it seems this constant was missing from the list. I have fixed it now.