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