SetSuspendState 関数 (powrprof.h)
電源を切ってシステムを中断します。 休止状態パラメーターに応じて、システムは中断 (スリープ) 状態または休止状態 (S4) に入ります。
構文
BOOLEAN SetSuspendState(
[in] BOOLEAN bHibernate,
[in] BOOLEAN bForce,
[in] BOOLEAN bWakeupEventsDisabled
);
パラメーター
[in] bHibernate
このパラメーターが TRUE の場合、システムは休止状態になります。 パラメーターが FALSE の場合、システムは中断されます。
[in] bForce
このパラメーターは何も作用しません。
[in] bWakeupEventsDisabled
このパラメーターが TRUE の場合、システムはすべてのウェイク イベントを無効にします。 パラメーターが FALSE の場合、システム ウェイク イベントはすべて有効なままです。
戻り値
関数が成功すると、戻り値は 0 以外になります。
関数が失敗した場合は、0 を返します。 詳細なエラー情報を得るには、GetLastError を呼び出します。
解説
呼び出し元プロセスには 、SE_SHUTDOWN_NAME 特権が必要です。 SE_SHUTDOWN_NAME特権を有効にするには、AdjustTokenPrivileges 関数を使用します。 詳細については、「 トークンでの特権の変更」を参照してください。
アプリケーションでは 、SetSuspendState を使用して、システムを動作状態からスタンバイ (スリープ)、または必要に応じて休止状態 (S4) 状態に移行できます。 この関数は 、SetSystemPowerState 関数に似ています。
PowrProf.h の使用方法の詳細については、「 Power Schemes」を参照してください。 システムをスリープ解除できるイベントの詳細については、「 システム ウェイクアップ イベント」を参照してください。
要件
| 要件 | 値 |
|---|---|
| サポートされている最小のクライアント | Windows XP (デスクトップ アプリのみ) |
| サポートされている最小のサーバー | Windows Server 2003 (デスクトップ アプリのみ) |
| 対象プラットフォーム | Windows |
| ヘッダー | powrprof.h |
| Library | PowrProf.lib |
| [DLL] | PowrProf.dll |