ホーム › System.TaskScheduler › ITriggerCollection

ITriggerCollection

COMIDispatch (デュアル)

📘 Microsoft Learn (日本語) · English

✅ IDispatch を実装(デュアルインターフェース)。HSP では comobj 経由でメソッド名による遅延バインド呼び出しができます(vtableインデックス不要)。

IID85df5081-1b24-4f32-878a-d9d14df4cb77継承元IDispatch呼び出し名前(IDispatch) または vtbl自前メソッド開始 vtbl7

公式ドキュメント

タスクのトリガーを追加、削除、および取得するためのメソッドを提供します。

解説(Remarks)

タスクの XML を読み書きする際、タスクのトリガーは Task Scheduler スキーマの Triggers 要素で指定します。

例

このインターフェイスの詳細とサンプルコードについては、Time Trigger Example (C++)、Event Trigger Example (C++)、Daily Trigger Example (C++)、Registration Trigger Example (C++)、Weekly Trigger Example (C++)、Logon Trigger Example (C++)、または Boot Trigger Example (C++) を参照してください。

メソッド 6

vtbl = vtable インデックス(0始まり)。IDispatch 実装のため HSP ではメソッド名でも呼べます(上記)。低レベルの index 呼び出し用に vtbl も掲載。0〜2 は IUnknown。

vtbl 7 HRESULT get_Count(INT* pCount)

コレクション内のトリガーの数を取得します。

pCount

INT*

inout

コレクションに含まれるトリガーの数を受け取る変数へのポインタである。

vtbl 8 HRESULT get_Item(INT index, ITrigger** ppTrigger)

指定したトリガーをコレクションから取得します。

index	INT	in	取得するトリガーの 1 始まりのインデックスを指定する。
ppTrigger	ITrigger**	out	指定したインデックスのトリガー (ITrigger) を受け取る出力ポインタである。

解説(Remarks)

コレクションは 1 始まりです。つまり、コレクション内の最初の項目のインデックスは 1 です。

vtbl 9 HRESULT get__NewEnum(IUnknown** ppEnum)

トリガーコレクションのコレクション列挙子を取得します。

ppEnum

IUnknown**

out

コレクションを列挙する列挙子 (IEnumVARIANT) の IUnknown を受け取る出力ポインタである。

vtbl 10 HRESULT Create(TASK_TRIGGER_TYPE2 type, ITrigger** ppTrigger)

タスクの新しいトリガーを作成します。

type

TASK_TRIGGER_TYPE2

このパラメーターには、次の TASK_TRIGGER_TYPE2 列挙定数のいずれかを設定します。

値	意味
TASK_TRIGGER_EVENT 0	特定のイベントが発生したときにタスクをトリガーします。
TASK_TRIGGER_TIME 1	1 日の特定の時刻にタスクをトリガーします。
TASK_TRIGGER_DAILY 2	日単位のスケジュールでタスクをトリガーします。たとえば、毎日、1 日おき、3 日ごとなど、特定の時刻にタスクを開始します。
TASK_TRIGGER_WEEKLY 3	週単位のスケジュールでタスクをトリガーします。たとえば、毎週または隔週の特定の曜日の午前 8:00 にタスクを開始します。
TASK_TRIGGER_MONTHLY 4	月単位のスケジュールでタスクをトリガーします。たとえば、特定の月の特定の日にタスクを開始します。
TASK_TRIGGER_MONTHLYDOW 5	月単位の曜日指定スケジュールでタスクをトリガーします。たとえば、特定の曜日、月内の特定の週、および年内の特定の月にタスクを開始します。
TASK_TRIGGER_IDLE 6	コンピューターがアイドル状態になったときにタスクをトリガーします。
TASK_TRIGGER_REGISTRATION 7	タスクが登録されたときにタスクをトリガーします。
TASK_TRIGGER_BOOT 8	コンピューターが起動したときにタスクをトリガーします。
TASK_TRIGGER_LOGON 9	特定のユーザーがログオンしたときにタスクをトリガーします。
TASK_TRIGGER_SESSION_STATE_CHANGE 11	特定のセッション状態が変化したときにタスクをトリガーします。

ppTrigger

ITrigger**

out

新しいトリガーを表す ITrigger インターフェイス。

NULL の ITrigger インターフェイスポインターへの参照を渡してください。NULL でないポインターを参照すると、ポインターが上書きされるためメモリリークが発生する可能性があります。

戻り値

このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

vtbl 11 HRESULT Remove(VARIANT index)

指定したトリガーを、タスクが使用するトリガーのコレクションから削除します。

index

VARIANT

削除するトリガーのインデックス。インデックス番号には LONG 値を使用します。

戻り値

このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

解説(Remarks)

項目を削除する際、コレクション内の最初の項目のインデックスは 1 で、最後の項目のインデックスは Count プロパティの値であることに注意してください。

このメソッドは、index パラメーターに渡された値が無効な場合に E_INVALIDARG を返します。

vtbl 12 HRESULT Clear()

コレクションからすべてのトリガーをクリアします。

戻り値

このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

HSP用 COM定義

#usecom / #comfunc によるHSPのCOM呼び出し定義。数字は vtbl インデックス(0始まり)。クラスIDが無い場合 #usecom の末尾は "{}"、ある場合は "{CLSID}"。

出力引数:

#define global IID_ITriggerCollection "{85DF5081-1B24-4F32-878A-D9D14DF4CB77}"
#usecom global ITriggerCollection IID_ITriggerCollection "{}"
#comfunc global ITriggerCollection_get_Count     7 var
#comfunc global ITriggerCollection_get_Item      8 int,sptr
#comfunc global ITriggerCollection_get__NewEnum  9 sptr
#comfunc global ITriggerCollection_Create        10 int,sptr
#comfunc global ITriggerCollection_Remove        11 int
#comfunc global ITriggerCollection_Clear         12
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。
; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。#define global IID_ITriggerCollection "{85DF5081-1B24-4F32-878A-D9D14DF4CB77}"
#usecom global ITriggerCollection IID_ITriggerCollection "{}"
#comfunc global ITriggerCollection_get_Count     7 sptr
#comfunc global ITriggerCollection_get_Item      8 int,sptr
#comfunc global ITriggerCollection_get__NewEnum  9 sptr
#comfunc global ITriggerCollection_Create        10 int,sptr
#comfunc global ITriggerCollection_Remove        11 int
#comfunc global ITriggerCollection_Clear         12
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。
; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。