IScheduledWorkItem::GetTriggerString メソッド (mstask.h)
[[この API は、以降のバージョンのオペレーティング システムまたは製品で変更または使用できない場合があります。 代わりに タスク スケジューラ 2.0 インターフェイス を使用してください。] ]
作業項目トリガーを記述する文字列を取得します。
構文
HRESULT GetTriggerString(
[in] WORD iTrigger,
[out] LPWSTR *ppwszTrigger
);
パラメーター
[in] iTrigger
取得するトリガーのインデックス。 最初のトリガーは常に 0 によって参照されます。 詳細については、「解説」を参照してください。
[out] ppwszTrigger
取得したトリガーの説明を含む null で終わる文字列へのポインター。 この文字列は、文字列が不要になった後、 CoTaskMemFree の呼び出しによって解放される必要があることに注意してください。
戻り値
GetTriggerString メソッドは、次のいずれかの値を返します。
リターン コード | 説明 |
---|---|
|
操作に成功しました。 |
|
引数が無効です。 |
|
メモリが不足しています。 |
注釈
トリガー インデックスは識別子ではありません。 これは、作業項目に関連付けられている現在のトリガーに対するトリガーの位置のみを示します。 たとえば、4 つのトリガーを作成すると、0 から 3 の番号が付きます。 ただし、2 番目のトリガーが削除されると、残りのトリガーには 0 から 2 の番号が付きます。 最初のトリガーのインデックスは常に 0 であり、最後のトリガーのインデックスは、作業項目のトリガーの合計数 (TriggerCount -1) より 1 少ないことに注意してください。
トリガー数は、 IScheduledWorkItem::GetTriggerCount を使用して取得できます。
例
タスクに関連付けられているすべてのトリガーのトリガー文字列を取得する方法の例については、「 トリガー文字列の取得の例」を参照してください。
要件
要件 | 値 |
---|---|
サポートされている最小のクライアント | Windows 2000 Professional [デスクトップ アプリのみ] |
サポートされている最小のサーバー | Windows 2000 Server [デスクトップ アプリのみ] |
対象プラットフォーム | Windows |
ヘッダー | mstask.h |
Library | Mstask.lib |
[DLL] | Mstask.dll |
再頒布可能パッケージ | Windows NT 4.0 および Windows 95 のインターネット エクスプローラー 4.0 以降 |