IScheduledWorkItem::SetFlags メソッド (mstask.h)
[[この API は、以降のバージョンのオペレーティング システムまたは製品で変更または使用できない場合があります。 代わりに 、タスク スケジューラ 2.0 インターフェイス を使用してください。 ]
任意の種類の 作業項目の動作を変更するフラグを設定します。
構文
HRESULT SetFlags(
DWORD dwFlags
);
パラメーター
dwFlags
次のフラグの 1 つ以上の組み合わせを指定する 値。
TASK_FLAG_INTERACTIVE
このフラグは、WINDOWS NT AT サービス ジョブを作業項目に変換するときに使用されます。 Windows NT AT サービス ジョブは、Windows NT スケジュール サービスのジョブの作成に使用されるWindows NTコマンド ライン ユーティリティである At.exe を参照します。 タスク スケジューラ サービスは Schedule サービスを置き換え、下位互換性があります。 変換は、タスク スケジューラが Windows NT/Windows 2000 にインストールされている場合に発生します。たとえば、インターネット エクスプローラー 4.0 をインストールする場合や、Windows 2000 にアップグレードした場合などです。 セットアップ プロセス中に、タスク スケジューラのインストール コードは、AT サービス用に作成されたジョブをレジストリで検索し、同じ操作を実行する作業項目を作成します。
このような変換されたジョブの場合、作業項目がユーザーに表示されることを意図している場合は、対話型フラグが設定されます。 このフラグが設定されていない場合、作業項目は [タスク] フォルダーに表示されず、作業項目の実行時に作業項目に関連付けられているユーザー インターフェイスはユーザーに表示されません。
TASK_FLAG_DELETE_WHEN_DONE
作業項目は、スケジュールされた実行時間がなくなったときに削除されます。
TASK_FLAG_DISABLED
作業項目が無効になっています。 これは、スケジュールされた時刻に作業項目が一時的に実行されないようにするのに役立ちます。
TASK_FLAG_HIDDEN
作成された作業項目は非表示になります。
TASK_FLAG_RUN_ONLY_IF_LOGGED_ON
作業項目は、 IScheduledWorkItem::SetAccountInformation で指定されたユーザーが対話形式でログオンしている場合にのみ実行されます。 このフラグは、ローカル アカウントで実行するように設定されている作業項目には影響しません。
TASK_FLAG_START_ONLY_IF_IDLE
作業項目は、スケジュールされた開始時刻にコンピューターが使用されていない場合にのみ開始されます。
TASK_FLAG_SYSTEM_REQUIRED
作業項目により、システムがバッテリ電源で実行されている場合は、システムが再開されるか、または起動します。 このフラグは、再開タイマーをサポートするシステムでのみサポートされます。
TASK_FLAG_KILL_ON_IDLE_END
作業項目の実行中にコンピューターがアイドル状態から非アイドル状態への移行を行うと、作業項目は終了します。 ユーザー入力なしで IdleWait トリガーの時間が経過するまで、コンピューターはアイドル状態とは見なされません。 アイドル トリガーの詳細については、「 アイドル トリガー」を参照してください。
TASK_FLAG_RESTART_ON_IDLE_RESUME
すべての作業項目の task_triggers が経過する前に、コンピューターがアイドル状態でない状態からアイドル状態への切り替えを行うと、作業項目が再び開始されます。 (このフラグは、TASK_FLAG_KILL_ON_IDLE_ENDと組み合わせて使用します)。
TASK_FLAG_DONT_START_IF_ON_BATTERIES
ターゲット コンピューターがバッテリ電源で実行されている場合、作業項目は起動しません。
TASK_FLAG_KILL_IF_GOING_ON_BATTERIES
作業項目が終了し、作業項目のターゲット コンピューターがバッテリ電源に切り替わると、関連付けられているアプリケーションが終了します。
TASK_FLAG_RUN_IF_CONNECTED_TO_INTERNET
作業項目は、現在有効なインターネット接続がある場合にのみ実行されます。
戻り値
SetFlags メソッドは、次のいずれかの値を返します。
| リターン コード | 説明 |
|---|---|
|
操作に成功しました。 |
|
引数が無効です。 |
|
メモリが不足しています。 |
注釈
SetFlags を呼び出してフラグを更新した後、プログラムは IPersistFile::Save メソッドを呼び出す必要があります。
このメソッドは、任意の種類のスケジュールされた作業項目で使用されるフラグを設定するために使用されます。 これに対し、 ITask::SetTaskFlags は、スケジュールされたタスクで使用されるフラグを設定するためにのみ使用されます。
要件
| 要件 | 値 |
|---|---|
| サポートされている最小のクライアント | Windows 2000 Professional [デスクトップ アプリのみ] |
| サポートされている最小のサーバー | Windows 2000 Server [デスクトップ アプリのみ] |
| 対象プラットフォーム | Windows |
| ヘッダー | mstask.h |
| Library | Mstask.lib |
| [DLL] | Mstask.dll |
| 再頒布可能パッケージ | Windows NT 4.0 および Windows 95 のインターネット エクスプローラー 4.0 以降 |