Share via


IOCTL_BATTERY_GETLEVELS (Compact 2013)

3/26/2014

This I/O control message returns the number of levels that the battery driver is capable of returning in the BatteryFlag and BackupBatteryFlag. Send this message with DeviceIoControl.

Syntax

BOOL DeviceIoControl(
    HANDLE hDevice,           // handle to the device
    DWORD dwIoControlCode,    // use IOCTL_BATTERY_GETLEVELS
    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_GETLEVELS for this operation.
  • lpInBuffer
    [in] Set to NULL.
  • nInBufferSize
    [in] Set to zero.
  • lpOutBuffer
    [in][out] A pointer to a LONG that will contain battery level information.
  • nOutBufferSize
    [in] sizeof(LONG).
  • 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.

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.

Requirements

Header

battery.h

See Also

Reference

Battery Driver IOCTLs
BatteryDrvrGetLevels
BatteryPDDGetLevels
DeviceIoControl

Other Resources

CreateFile