IOCTL_HPMI_BATTERY_UTILIZATION_HINT IOCTL (hpmi.h)

Article
05/18/2021

[Some information relates to pre-released product which may be substantially modified before it's commercially released. Microsoft makes no warranties, express or implied, with respect to the information provided here.]

Set command sent to HPMI to provide battery utilization hints.

Important Preliminary Information

Major code

IRP_MJ_DEVICE_CONTROL

Input buffer

The AssociatedIrp.SystemBuffer member of the I/O request packet (IRP) points to an initiator-allocated buffer that is used both as the input buffer and the output buffer for the request. On input, this buffer contains a HPMI_BATTERY_UTILIZATION_HINT structure in which the version is set to a valid value.

Input buffer length

The Parameters.DeviceIoControl.InputBufferLength member of the IRP's current I/O stack location (IO_STACK_LOCATION) is set to the size in bytes of the buffer that is pointed to by the AssociatedIrp.SystemBuffer member. This size must be greater than or equal to sizeof HPMI_BATTERY_UTILIZATION_HINT structure or the request will fail with an error status of STATUS_INVALID_PARAMETER.

Output buffer

TBD

Output buffer length

TBD

Input / Output buffer

TBD

Input / Output buffer length

TBD

Status block

Irp->IoStatus.Status is set to STATUS_SUCCESS if the request is successful. Otherwise, Status to the appropriate error condition as a NTSTATUS code, for example STATUS_INVALID_PARAMETER.

Remarks

This IOCTL may be issued multiple times if HPMI requests HPMI_REQUEST_SERVICE_BATTERY_UTILIZATION_HINTS service.

Requirements

Requirement	Value
Minimum supported client	Available in Windows 10, version 1709 and later versions of the Windows operating systems.
Header	hpmi.h (include Hpmi.h)