IConsolePower

IConsolePower インターフェイスは、電源管理をサポートするオペレーティングシステムにおいて、実行状態とアイドルタイマーを制御します。

SetExecutionState メソッドは、現在のスレッドの実行状態を設定します。

成功した場合、戻り値は S_OK です。電源管理をサポートしないシステムで呼び出された場合、このメソッドは S_FALSE を返します。その他の戻り値はエラーコードを示します。

SetThreadExecutionState ではなく IConsolePower::SetExecutionState を呼び出してください。スナップインは SetThreadExecutionState 関数を直接呼び出してはなりません。直接呼び出すと、同一スレッド上で複数のスナップインが実行されている場合に競合が発生します。

スナップインは自身の電源要件を定義し、 SetExecutionState を呼び出して MMC に送信します。スナップインが SetExecutionState を呼び出すと、その実行状態はスナップインが再度 SetExecutionState を呼び出すまで有効なままになります。SetExecutionState を呼び出した後は、以降の SetExecutionState の呼び出しに同一インスタンスの IConsolePower インターフェイスを使用しなければならないことに注意してください。スナップインが同一インスタンスの IConsolePower を使用しない場合、MMC は SetThreadExecutionState を適切に呼び出せません。MMC は各スナップインの実行状態を追跡する配列を保持しており、スレッド上で実行されているすべてのスナップインに対して SetThreadExecutionState を呼び出します。

Examples

HRESULT hr;

// ディスプレイとシステムが必要であることを指定します。
// pConsolePower は事前に CoCreateInstance メソッドで
// 作成されています。
hr = pConsolePower->SetExecutionState(ES_DISPLAY_REQUIRED | ES_SYSTEM_REQUIRED,0);
switch (hr)
{
    case S_OK:
        OutputDebugString(_T("SetExecutionState: Succeeded\n"));
        break;

    case S_FALSE:
        // システムが電源管理をサポートしていません。
        OutputDebugString(_T("SetExecutionState: Unsupported\n"));
        break;

    default:
        // 予期しないエラーが発生しました。
        OutputDebugString(_T("SetExecutionState: Failure\n"));
        break;
}

ResetIdleTimer メソッドは、指定された電源管理のアイドルタイマーをリセットします。

成功した場合、戻り値は S_OK です。電源管理をサポートしないシステムで呼び出された場合、このメソッドは S_FALSE を返します。その他の戻り値はエラーコードを示します。

SetThreadExecutionState を呼び出す代わりに IConsolePower::ResetIdleTimer を呼び出してください。スナップインは SetThreadExecutionState 関数を直接呼び出してはなりません。直接呼び出すと、同一スレッド上で複数のスナップインが実行されている場合に競合が発生します。代わりに、スナップインは SetExecutionState を呼び出す必要があります。アイドルタイマーをリセットすると、アイドル期間の計測が最初からやり直されます。スナップインが IConsolePower::SetExecutionState を呼び出して継続的な実行状態を指定していない場合、 ResetIdleTimer を定期的に呼び出すことで、システムまたはディスプレイの電源管理ルーチンが呼び出されるまでの時間を延ばすことができます。

Examples

HRESULT hr;

// ディスプレイとシステムの両方のアイドルタイマーをリセットします。
// pConsolePower は事前に CoCreateInstance メソッドで
// 作成されています。
hr = pConsolePower->ResetIdleTimer(
             ES_DISPLAY_REQUIRED | ES_SYSTEM_REQUIRED);
switch (hr)
{
    case S_OK:
        OutputDebugString(_T("ResetIdleTimer: Succeeded\n"));
        break;

    case S_FALSE:
        // システムが電源管理をサポートしていません。
        OutputDebugString(_T("ResetIdleTimer: Unsupported\n"));
        break;

    default:
        // 予期しないエラーが発生しました。
        OutputDebugString(_T("ResetIdleTimer: Failure\n"));
        break;
}