wpChangePowerState - Parameters

somSelf (WPPower *) - input

Pointer to the object on which the method is being invoked.

Points to an object of class WPPower.

ulParm1 (ULONG) - input

Parameter 1.

This parameter contains a complex value. The ULONG value is composed of two separate USHORT values. These values are as follows:

SubId (USHORT)

The requested change power state identifier. SubId defines the type of power state transition being requested.

0x0006

Set Power State Request

The set power state request is used to initiate a change in the system's power conservation support state. The ulparm2 value determines the scope of the request.

Note: All other SubId values are reserved for future use.
0 (USHORT)
Reserved value, must be 0.
Example of ulParm1 construction:

SubId(USHORT) = 0006h
ulParm1 = MAKEULONG(SubId,0)

ulparm2 (ULONG) - input

Parameter 2.

This parameter contains a complex value. The ULONG value is composed of two separate USHORT values.

DevId (USHORT)

Requested device identifier.

0x0001

All system-managed services.

System-managed devices are the hardware-system specific set of devices that support power-managed states. Because this set of devices is hardware specific, each system configuration may have unique support capabilities.

Note: All other DevId values are reserved for future use.
PwrState (USHORT)
Requested power state that the devices specified in DevId are to be set to.

0x0001

Standby State Request.

This state indicates that the specified devices should be set into a power conservation mode that consists of a partial power level that allows for improved energy conservation without noticeable power up delays for re-established operation.

0x0002
Suspend State Request.

This state indicates that the specified devices should be set into a power conservation mode that consists of a partial power level that allows for substantial energy conservation with accepted noticeable power-up delays for re-established operation.

Note: All other PwrState values are reserved for future use.

Example of ulparm2 construction:

DevId(USHORT) = 0001h
PwrState(USHORT) = 0002h
ulParm2 = MAKEULONG(DevId,PwrState)

rc (BOOL) - returns

Success indicator.

TRUE

The request was successful.
FALSE
The request was unsuccessful.

---

[Back: wpChangePowerState Return Value - rc]
[Next: wpChangePowerState - Related Methods]