SetPowerState

SetPowerState defines the desired power state for a logical device and when a device should be put into that state. The desired power state is specified by setting the PowerState parameter to one of the following integer values: 1=”Full Power”, 2=”Power Save – Low Power Mode”, 3=”Power Save – Standby”, 4=”Power Save – Other”, 5=”Power Cycle” or 6=”Power Off”. The Time parameter (for all state changes, except 5, “Power Cycle”) indicates 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. SetPowerState should return 0 if successful, 1 if the specified PowerState and Time request is not supported, and some other value if any other error occurred. In a subclass, the set of possible return codes could be specified, using a ValueMap qualifier on the method. The strings to which the ValueMap contents are ‘translated’ may also be specified in the subclass as a Values array qualifier.

Syntax

UInt32 ReturnValue = SetPowerState(UInt16 PowerState, DateTime Time)

Parameters

Return Value

Examples

See Also

Help and Questions

  Community Content

You are cordially invited to add knowledge to this page. If you have sample code or additional information related to this WMI class, please share it. Use the comment form to send your information. We will edit and incorparate it into the reference library. Thank you!

Please do not use the comment form to submit questions. If you have questions or need assistance, visit our free forum: Help me with WMI.

Content last updated: 2013-12-27 12:18:04 (UTC).