GetFirstSleepState method
The GetFirstSleepState method returns the lightest supported sleep state for a computer.
Syntax
HRESULT GetFirstSleepState(
[out, retval] LONG *SleepState
);
Parameters
- SleepState [out, retval]
The address of the variable that will receive the sleep state.
Return value
GetFirstSleepState returns a standard HRESULT.
Remarks
If the GetFirstSleepState method succeeds, the variable that is referenced by the SleepState parameter contains the lightest sleep state that the system supports. This value is in the range 0 (S0) to 4 (S4) inclusive. If the value is 0, the system does not support any sleep states.
See also
Send comments about this topic to Microsoft
Build date: 1/12/2012