PoClearPowerRequest - NtDoc
Native API online documentation, based on the System Informer
(formerly Process Hacker) phnt
headers
// ntifs.h
NTSTATUS PoClearPowerRequest(
[in, out] PVOID PowerRequest,
[in] POWER_REQUEST_TYPE Type
);
View the official Windows Driver Kit DDI reference// wdm.h
NTSTATUS PoClearPowerRequest(
[in, out] PVOID PowerRequest,
[in] POWER_REQUEST_TYPE Type
);
View the official Windows Driver Kit DDI referenceNo description available.
The PoClearPowerRequest routine decrements the count for the specified power request type.
PowerRequest [in, out]A pointer to a power request object that was created by the PoCreatePowerRequest routine.
Type [in]The type of the power request. Set this parameter to the following POWER_REQUEST_TYPE enumeration value:
PoClearPowerRequest returns STATUS_SUCCESS if the call is successful. If the call fails, possible error return codes include the following:
| Return code | Description |
|---|---|
| STATUS_NOT_SUPPORTED | The parameter Type is set to an unsupported value. |
A driver can call the PoSetPowerRequest routine to request that the power manager override several types of default power behavior, which are specified as POWER_REQUEST_TYPE enumeration values. To restore the default behavior, the driver cancels the request by calling the PoClearPowerRequest routine.
The power manager maintains a count of the active requests for each power request type. The PoSetPowerRequest routine increments the count for the specified power request type by one. The PoClearPowerRequest routine decrements the count by one. A nonzero count indicates that requests from one or more components are active. After the count decrements to zero, the power manager restores the default behavior for the specified power request type.
The PoClearPowerRequest routine decrements the count for the specified power request type.
PowerRequest [in, out]A pointer to a power request object that was created by the PoCreatePowerRequest routine.
Type [in]The type of the power request. Set this parameter to the following POWER_REQUEST_TYPE enumeration value:
PoClearPowerRequest returns STATUS_SUCCESS if the call is successful. If the call fails, possible error return codes include the following:
| Return code | Description |
|---|---|
| STATUS_NOT_SUPPORTED | Parameter Type is set to an unsupported value. |
A driver can call the PoSetPowerRequest routine to request that the power manager override several types of default power behavior, which are specified as POWER_REQUEST_TYPE enumeration values. To restore the default behavior, the driver cancels the request by calling the PoClearPowerRequest routine.
The power manager maintains a count of the active requests for each power request type. The PoSetPowerRequest routine increments the count for the specified power request type by one. The PoClearPowerRequest routine decrements the count by one. A nonzero count indicates that requests from one or more components are active. After the count decrements to zero, the power manager restores the default behavior for the specified power request type.