SetPowerState method of the CIM_Controller class

The SetPowerState method sets the desired power state for a logical device and when a 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.

Syntax

uint32 SetPowerState(
  [in]  uint16 PowerState,
  [in]  datetime Time
);

Parameters

PowerState [in]

A ValueMap value that specifies the desired power state for the logical device.

Value	Meaning
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.

Remarks

This method is currently 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.

Examples

For script code examples, see WMI Tasks for Scripts and Applications and the TechNet ScriptCenter Script Repository.

For C++ code examples, see WMI C++ Application Examples.

Requirements

See also

CIM_Controller

CIM_Controller

Send comments about this topic to Microsoft

Build date: 11/19/2012