SetPowerState method of the CIM_Battery class
The SetPowerState method sets the desired power state for a logical device and when the device should be put into that state. In a subclass, the set of possible return codes should be specified using a ValueMap qualifier on the method. The strings to which the ValueMap contents are translated should also be specified in the subclass as a Values array qualifier. This method is inherited from CIM_LogicalDevice.
Important
The DMTF (Distributed Management Task Force) CIM (Common Information Model) classes are the parent classes upon which WMI classes are built. WMI currently supports only the CIM 2.x version schemas.
Syntax
uint32 SetPowerState(
[in] uint16 PowerState,
[in] datetime Time
);
Parameters
-
PowerState [in]
-
A ValueMap value that specifies the desired power state for this logical device.
-
1
-
Full power.
-
2
-
Power save low-power mode.
-
3
-
Power save standby.
-
4
-
Power save other.
-
5
-
Power cycle.
-
6
-
Power off.
Time [in]
Specifies when the power state should be set, either as a regular date-time value or as an interval value (where the interval begins when the method invocation is received). When the PowerState parameter is equal to 5 ("Power Cycle"), the Time parameter indicates when the device should power-on again. Power-off is immediate.
Return value
Returns 0 (zero) if successful, 1 (one) if the specified PowerState and Time request is not supported, and another value if any other error occurred.
Remarks
Currently, this method is not implemented by WMI. To use this method, you must implement it in your own provider.
This documentation is derived from the CIM class descriptions published by the DMTF. Microsoft may have made changes to correct minor errors, conform to Microsoft SDK documentation standards, or provide more information.
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client |
Windows Vista |
| Minimum supported server |
Windows Server 2008 |
| Namespace |
Root\CIMV2 |
| MOF |
|
| DLL |
|