Skip to content

Latest commit

 

History

History
137 lines (112 loc) · 4.32 KB

nf-winbase-powerclearrequest.md

File metadata and controls

137 lines (112 loc) · 4.32 KB
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NF:winbase.PowerClearRequest
PowerClearRequest function (winbase.h)
Decrements the count of power requests of the specified type for a power request object.
PowerClearRequest
PowerClearRequest function
PowerRequestAwayModeRequired
PowerRequestDisplayRequired
PowerRequestExecutionRequired
PowerRequestSystemRequired
base.powerclearrequest
winbase/PowerClearRequest
base\powerclearrequest.htm
base
794248b1-5aa8-495e-aca6-1a1f35dc9c7f
12/05/2018
PowerClearRequest, PowerClearRequest function, PowerRequestAwayModeRequired, PowerRequestDisplayRequired, PowerRequestExecutionRequired, PowerRequestSystemRequired, base.powerclearrequest, winbase/PowerClearRequest
winbase.h
Windows.h
Windows
Windows 7 [desktop apps only]
Windows Server 2008 R2 [desktop apps only]
Kernel32.lib
Kernel32.dll
Windows
19H1
PowerClearRequest
winbase/PowerClearRequest
c++
APIRef
kbSyntax
DllExport
kernel32.dll
API-MS-Win-Core-Kernel32-Legacy-l1-1-1.dll
kernel32legacy.dll
API-MS-Win-Core-Kernel32-Legacy-l1-1-2.dll
API-MS-Win-Core-Kernel32-Legacy-L1-1-3.dll
API-MS-Win-Core-Kernel32-Legacy-L1-1-4.dll
API-MS-Win-Core-Kernel32-Legacy-L1-1-5.dll
PowerClearRequest

PowerClearRequest function

-description

Decrements the count of power requests of the specified type for a power request object.

-parameters

-param PowerRequest [in]

A handle to a power request object.

-param RequestType [in]

The power request type to be decremented. This parameter can be one of the following values.

Value Meaning
PowerRequestDisplayRequired
The display remains on even if there is no user input for an extended period of time.
PowerRequestSystemRequired
The system continues to run instead of entering sleep after a period of user inactivity.
PowerRequestAwayModeRequired
The system enters away mode instead of sleep. In away mode, the system continues to run but turns off audio and video to give the appearance of sleep.
PowerRequestExecutionRequired
The calling process continues to run instead of being suspended or terminated by process lifetime management mechanisms. When and how long the process is allowed to run depends on the operating system and power policy settings.

When a PowerRequestExecutionRequired request is active, it implies PowerRequestSystemRequired.

The PowerRequestExecutionRequired request type can be used only by applications. Services cannot use this request type.

Windows 7 and Windows Server 2008 R2:  This request type is supported starting with Windows 8 and Windows Server 2012.

-returns

If the function succeeds, it returns a nonzero value.

If the function fails, it returns zero. To get extended error information, call GetLastError.

-see-also

PowerCreateRequest

PowerSetRequest