Share via

IOCTL_BATTERY_GETLIFETIMEINFO (Compact 2013)

  • Article

3/26/2014

This I/O control message retrieves the time the user changed the batteries, the amount of time they used the batteries, and the amount of time they used the batteries before replacing them. Send this message with DeviceIoControl.

Syntax

BOOL DeviceIoControl(
    HANDLE hDevice,           // handle to the device
    DWORD dwIoControlCode,    // use IOCTL_BATTERY_GETLIFETIMEINFO
    LPVOID lpInBuffer,        // pointer to input buffer
    DWORD nInBufferSize,      // input buffer size
    LPVOID lpOutBuffer,       // pointer to output buffer
    DWORD nOutBufferSize,     // output buffer size
    LPDWORD lpBytesReturned,  // number of bytes returned
    OVERLAPPED lpOverlapped   // pointer to OVERLAPPED structure
);

Parameters

  • hDevice
    [in] Handle to the device. To obtain a device handle, call CreateFile.
  • dwIoControlCode
    [in] Control code for the operation. Use IOCTL_BATTERY_GETLIFETIMEINFO for this operation.
  • lpInBuffer
    [in] Set to NULL.
  • nInBufferSize
    [in] Set to zero.
  • nOutBufferSize
    [in] Set to sizeof(BATTERYLIFETIMEINFO).
  • lpBytesReturned
    [out] Long pointer to a variable that receives the size, in bytes, of the data stored into the buffer pointed to by lpOutBuffer.
  • lpOverlapped
    [in] Not supported, set to NULL.

Return Values

Returns TRUE if successful; otherwise, returns FALSE. If the value is TRUE, pdwBytesTransferred will be sizeof(BATTERYLIFETIMEINFO).

Remarks

To get extended error information, call GetLastError. GetLastError may return other standard error messages as appropriate.

For more information about the data returned by using this I/O control, see BatteryPDDGetLevels and BatteryDrvrGetLevels.

This IOCTL does not return meaningful data unless the battery driver supports change notification.

For more information, see BatteryPDDSupportsChangeNotification and BatteryDrvrSupportsChangeNotification.

Requirements

Header

battery.h

See Also

Reference

Battery Driver IOCTLs
BatteryDrvrSupportsChangeNotification
BATTERYLIFETIMEINFO
BatteryPDDSupportsChangeNotification
DeviceIoControl