IScheduledWorkItem::SetIdleWait メソッド (mstask.h)
[[この API は、以降のバージョンのオペレーティング システムまたは製品で変更または使用できない場合があります。 代わりに 、タスク スケジューラ 2.0 インターフェイス を使用してください。 ]
作業項目を実行する前にシステムがアイドル状態である必要がある分数を設定します。
構文
HRESULT SetIdleWait(
[in] WORD wIdleMinutes,
[in] WORD wDeadlineMinutes
);
パラメーター
[in] wIdleMinutes
作業項目を実行する前にシステムをアイドル状態にしておく必要がある時間 (分単位) を指定する 値。
[in] wDeadlineMinutes
pwIdleMinutes で返されるアイドル時間をタスク スケジューラが待機する最大時間 (分) を示す 値です。
戻り値
SetIdleWait メソッドはS_OKを返します。
注釈
ここで指定したアイドル時間は、 アイドル トリガー と アイドル状態と組み合わせて使用されます。 詳細については、「 タスクのアイドル状態」を参照してください。 アイドル 状態のトリガーは、スケジュールされた時刻に関連付けられていないイベント ベースのトリガーです。 これに対し、アイドル状態は、タスクのスケジュールされた開始時刻に関連付けられます。
アイドル トリガーを指定するには、TASK_TRIGGERのTASK_TRIGGER_TYPE メンバーを TASK_EVENT_TRIGGER_ON_IDLE に設定します。 アイドル トリガーは、 システムが wIdleMinutes で指定された時間アイドル状態になったときに発生します。
アイドル状態を設定する場合 は、IScheduledWorkItem::SetFlags を呼び出します。 TASK_FLAG_START_ONLY_IF_IDLE フラグが設定されている場合、作業項目は 、wIdleMinutes で指定された時間だけシステムがアイドル状態になった場合にのみ、スケジュールされた時刻に実行されます。 タスク スケジューラ サービスは、スケジュールされた開始時刻を過ぎて wDeadlineMinutes で指定された分数まで待機し、システムがアイドル状態になったかどうかを確認します。
アプリケーションは、SetIdleWait を呼び出した後に IPersistFile::Save メソッドを呼び出して、アイドル待機間隔を更新する必要があります。
例
アイドル トリガーの作成時にアイドル待機時間を設定する方法の例については、「アイドル トリガーの 作成の例」を参照してください。
要件
| 要件 | 値 |
|---|---|
| サポートされている最小のクライアント | Windows 2000 Professional [デスクトップ アプリのみ] |
| サポートされている最小のサーバー | Windows 2000 Server [デスクトップ アプリのみ] |
| 対象プラットフォーム | Windows |
| ヘッダー | mstask.h |
| Library | Mstask.lib |
| [DLL] | Mstask.dll |
| 再頒布可能パッケージ | Windows NT 4.0 および Windows 95 のインターネット エクスプローラー 4.0 以降 |