Parameter #2 in Example #2 of the Shutdown documentation

Share your ideas as to how the documentation can be improved.
iPhilip
Posts: 802
Joined: 02 Oct 2013, 12:21

Parameter #2 in Example #2 of the Shutdown documentation

Post by iPhilip » 08 Feb 2021, 12:08

In Example #2 of the Shutdown documentation, it states
Parameter #2: Pass 1 instead of 0 to suspend immediately rather than asking each application for permission.
According to Microsoft's documentation of the SetSuspendState function:
bForce
This parameter has no effect.
I recommend that the above line be changed in the v1 and v2 documentation page to
Parameter #2: This parameter has no effect.
Windows 10 Pro (64 bit) - AutoHotkey v2.0+ (Unicode 64-bit)

lexikos
Posts: 9560
Joined: 30 Sep 2013, 04:07
Contact:

Re: Parameter #2 in Example #2 of the Shutdown documentation

Post by lexikos » 27 Feb 2021, 06:27

The current Microsoft documentation is incomplete. It is missing a paragraph which applies to OS versions that Microsoft (and AutoHotkey v2) no longer support.
Windows Server 2003, Windows XP, and Windows 2000: If this parameter is
TRUE, the system suspends operation immediately; if it is FALSE, the system
broadcasts a PBT_APMQUERYSUSPEND event to each application to request
permission to suspend operation.

iPhilip
Posts: 802
Joined: 02 Oct 2013, 12:21

Re: Parameter #2 in Example #2 of the Shutdown documentation

Post by iPhilip » 23 Mar 2021, 14:47

lexikos wrote:
27 Feb 2021, 06:27
The current Microsoft documentation is incomplete. It is missing a paragraph which applies to OS versions that Microsoft (and AutoHotkey v2) no longer support.
Windows Server 2003, Windows XP, and Windows 2000: If this parameter is
TRUE, the system suspends operation immediately; if it is FALSE, the system
broadcasts a PBT_APMQUERYSUSPEND event to each application to request
permission to suspend operation.
Hi @lexikos,

Thank you for looking into this. I am not surprised that the Microsoft documentation page is incomplete, seeing that those operating systems (Windows Server 2003, Windows XP, and Windows 2000) haven't been supported for at least 5 years. Seeing that AutoHotkey still supports Windows XP, I would suggest the following change for the v1 documentation page
Parameter #2: Pass 1 instead of 0 to suspend immediately rather than asking each application for permission. For Windows Vista+ this parameter has no effect.
and the following change for the v2 documentation page.
Parameter #2: This parameter has no effect.
Windows 10 Pro (64 bit) - AutoHotkey v2.0+ (Unicode 64-bit)

Post Reply

Return to “Suggestions on Documentation Improvements”