IRAPISession::CeGetSystemPowerStatusEx

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

This method retrieves the power status of the system on a remote Windows Embedded CE–based device. The status indicates whether the system is running on AC or DC power, whether or not the batteries are currently charging, and the remaining life of main and backup batteries.

Syntax

BOOL CeGetSystemPowerStatusEx(
  PSYSTEM_POWER_STATUS_EX pstatus, 
  BOOL fUpdate 
);

Parameters

• pstatus
  [out] Pointer to the SYSTEM_POWER_STATUS_EX structure receiving the power status information.

• fUpdate
  [in] If this Boolean value is set to TRUE, IRAPISession::CeGetSystemPowerStatusEx gets the latest information from the device driver; otherwise it retrieves cached information that may be out-of-date by several seconds.

Return Value

Nonzero indicates success. Zero indicates failure.

Remarks

The IRAPISession::CeGetSystemPowerStatusEx method is not supported for emulation.

Requirements

See Also

Reference

IRAPISession
SYSTEM_POWER_STATUS_EX (RAPI)