IScheduledWorkItem::D eleteTrigger メソッド (mstask.h)
[[この API は、以降のバージョンのオペレーティング システムまたは製品で変更または使用できない場合があります。 代わりに 、タスク スケジューラ 2.0 インターフェイス を使用してください。 ]
作業項目からトリガーを削除します。
構文
HRESULT DeleteTrigger(
[in] WORD iTrigger
);
パラメーター
[in] iTrigger
削除するトリガーを指定するトリガー インデックス値。 詳細については、「解説」を参照してください。
戻り値
DeleteTrigger メソッドは、次のいずれかの値を返します。
| リターン コード | 説明 |
|---|---|
|
操作に成功しました。 |
|
引数が無効です。 |
|
メモリが不足しています。 |
注釈
トリガーの作成時に、トリガーごとにトリガー インデックスが作成されます。 ただし、特定のトリガーの一意識別子ではありません。 たとえば、4 つのトリガーを作成すると、0 から 3 の番号が付きます。 ただし、2 つ目のトリガーが削除された場合、残りのトリガーには 0 から 2 の番号が付きます。 最初のトリガーのインデックスは常に 0 であり、最後のトリガーのインデックスは、作業項目のトリガーの合計数 (TriggerCount -1) よりも 1 少ない点に注意してください。
トリガー数は、 IScheduledWorkItem::GetTriggerCount を使用して取得できます。
トリガーの削除を完了するには、DeleteTrigger を呼び出した後に IPersistFile::Save メソッドを呼び出す必要があります。 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 以降 |