IOCTL_BATTERY_GETSYSTEMPOWERSTATUSEX (Compact 2013)
3/26/2014
This I/O control message retrieves information for the GetSystemPowerStatusEx system call. Send this message with DeviceIoControl.
Syntax
BOOL DeviceIoControl(
HANDLE hDevice, // handle to the device
DWORD dwIoControlCode, // use IOCTL_BATTERY_GETSYSTEMPOWERSTATUSEX
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_GETSYSTEMPOWERSTATUSEX for this operation.
- lpInBuffer
[in] Pointer to a BOOL, fUpdate.
- nInBufferSize
[in] Set to sizeof(BOOL).
- lpOutBuffer
[in][out] A pointer to a SYSTEM_POWER_STATUS_EX structure.
- nOutBufferSize
[in] Set to sizeof(SYSTEM_POWER_STATUS_EX).
- 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(SYSTEM_POWER_STATUS_EX).
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.
If fUpdate is set to TRUE, this IOCTL gets the latest information from the battery PDD, otherwise it retrieves cached information that may be out-of-date by several seconds.
For more information, see GetSystemPowerStatusEx and BatteryPDDGetStatus.
Requirements
Header |
battery.h |
See Also
Reference
Battery Driver IOCTLs
BatteryPDDGetStatus
DeviceIoControl