IConsolePower::ResetIdleTimer メソッド (mmc.h)
ResetIdleTimer メソッドは、指定された電源管理アイドル タイマーをリセットします。
構文
HRESULT ResetIdleTimer(
[in] DWORD dwFlags
);
パラメーター
[in] dwFlags
アイドル タイマーのリセットに使用されるフラグ。 次のフラグのうち 1 つ以上を使用できます。 詳細については、「 SetThreadExecutionState」を参照してください。
ES_DISPLAY_REQUIRED
ディスプレイ (モニター) のアイドル タイマーをリセットします。
ES_SYSTEM_REQUIRED
システム アイドル タイマーをリセットします。
戻り値
成功した場合、戻り値はS_OK。 このメソッドは、電源管理をサポートしていないシステムで呼び出されると、S_FALSEを返します。 その他の戻り値は、エラー コードを示します。
解説
SetThreadExecutionState を呼び出す代わりに、IConsolePower::ResetIdleTimer を呼び出します。 スナップインは SetThreadExecutionState 関数を直接呼び出してはならないため、同じスレッドで複数のスナップインが実行されている場合は競合が発生します。 代わりに、スナップインは SetExecutionState を呼び出す必要があります。 アイドル タイマーをリセットすると、アイドル期間の追跡で最初からやり直されます。 スナップインが IConsolePower::SetExecutionState を呼び出して継続的な実行状態を指定しない場合、ResetIdleTimer を定期的に呼び出して、システムまたは表示電源管理ルーチンが呼び出されるまでの時間を長くすることができます。
例
HRESULT hr;
// Reset both the display and system idle timers.
// pConsolePower was created previously by
// the CoCreateInstance method.
hr = pConsolePower->ResetIdleTimer(
ES_DISPLAY_REQUIRED | ES_SYSTEM_REQUIRED);
switch (hr)
{
case S_OK:
OutputDebugString(_T("ResetIdleTimer: Succeeded\n"));
break;
case S_FALSE:
// The system does not support power management.
OutputDebugString(_T("ResetIdleTimer: Unsupported\n"));
break;
default:
// Unexpected error occurred.
OutputDebugString(_T("ResetIdleTimer: Failure\n"));
break;
}
要件
サポートされている最小のクライアント | Windows Vista |
サポートされている最小のサーバー | Windows Server 2008 |
対象プラットフォーム | Windows |
ヘッダー | mmc.h |
Library | Mmc.lib |
[DLL] | Mmcndmgr.dll |