IsRtcWakeSupported method

  • Article

The IsRtcWakeSupported method determines whether a computer can wake up from the specified sleep state by using the Real Time Clock (RTC).

Syntax

HRESULT IsRtcWakeSupported(
  [in]           LONG SleepState,
  [out, retval]  VARIANT_BOOL *pValue
);

Parameters

  • SleepState [in]
    The sleep state that IsRtcWakeSupported checks to see whether the computer can be awakened by the RTC. This value must be in the range 1 (S1) to 4 (S4) inclusive.

  • pValue [out, retval]
    IsRtcWakeSupported returns VARIANT_TRUE in pValue if the RTC can automatically wake the computer from the specified sleep state and VARIANT_FALSE if not.

Return value

IsRtcWakeSupported returns a standard HRESULT.

See also

Console

 

 

Send comments about this topic to Microsoft

Build date: 1/12/2012