Win32 API 日本語リファレンス
ホーム › System.TaskScheduler › ITrigger

ITrigger

COMIDispatch (デュアル)
📘 Microsoft Learn (日本語) · English
✅ IDispatch を実装(デュアルインターフェース)。HSP では comobj 経由でメソッド名による遅延バインド呼び出しができます(vtableインデックス不要)。
IID09941815-ea89-4b5b-89e0-2a773801fac3継承元IDispatch呼び出し名前(IDispatch) または vtbl自前メソッド開始 vtbl7

公式ドキュメント

すべてのトリガーオブジェクトに継承される共通のプロパティを提供します。

解説(Remarks)

Task Scheduler は、タスクが使用できるさまざまなトリガーに対して、次の個別のインターフェイスを提供します。

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

例

このインターフェイスに関する詳細情報とサンプルコードについては、Time Trigger Example (C++) を参照してください。

メソッド 13

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

vtbl 7 HRESULT get_Type(TASK_TRIGGER_TYPE2* pType)

トリガーの種類を取得します。

pTypeTASK_TRIGGER_TYPE2*inoutトリガーの種類を表す TASK_TRIGGER_TYPE2 値を受け取る変数へのポインタである。
vtbl 8 HRESULT get_Id(LPWSTR* pId)

トリガーの識別子を取得または設定します。(Get)

pIdLPWSTR*inoutトリガーの識別子文字列を受け取る出力ポインタである。SysFreeString で解放する。

解説(Remarks)

タスクの XML を読み書きする場合、トリガーの識別子は Task Scheduler スキーマの各トリガー要素の Id 属性(たとえば BootTrigger 要素の Id 属性)で指定します。

vtbl 9 HRESULT put_Id(LPWSTR id)

トリガーの識別子を取得または設定します。(Put)

idLPWSTRinトリガーに設定する識別子文字列を指定する。

解説(Remarks)

タスクの XML を読み書きする場合、トリガーの識別子は Task Scheduler スキーマの各トリガー要素の Id 属性(たとえば BootTrigger 要素の Id 属性)で指定します。

vtbl 10 HRESULT get_Repetition(IRepetitionPattern** ppRepeat)

タスクを実行する頻度と、タスクの開始後に繰り返しパターンを継続する期間を示す値を取得または設定します。(Get)

ppRepeatIRepetitionPattern**outトリガーの繰り返しパターン (IRepetitionPattern) を受け取る出力ポインタである。

解説(Remarks)

タスク用に独自の XML を読み書きする場合、トリガーの繰り返しパターンは Task Scheduler スキーマの Repetition 要素で指定します。

例

このプロパティに関する詳細情報とサンプルコードについては、Daily Trigger Example (C++) を参照してください。

vtbl 11 HRESULT put_Repetition(IRepetitionPattern* pRepeat)

タスクを実行する頻度と、タスクの開始後に繰り返しパターンを継続する期間を示す値を取得または設定します。(Put)

pRepeatIRepetitionPattern*inトリガーに設定する繰り返しパターン (IRepetitionPattern) へのポインタである。

解説(Remarks)

タスク用に独自の XML を読み書きする場合、トリガーの繰り返しパターンは Task Scheduler スキーマの Repetition 要素で指定します。

例

このプロパティに関する詳細情報とサンプルコードについては、Daily Trigger Example (C++) を参照してください。

vtbl 12 HRESULT get_ExecutionTimeLimit(LPWSTR* pTimeLimit)

このトリガーによって起動されるタスクの実行が許可される最大時間を取得または設定します。(Get)

pTimeLimitLPWSTR*inoutトリガーによって開始されたタスクの最大実行時間を ISO 8601 期間形式の文字列で受け取る出力ポインタである。SysFreeString で解放する。

解説(Remarks)

この文字列の形式は PnYnMnDTnHnMnS です。ここで、nY は年数、nM は月数、nD は日数、'T' は日付と時刻の区切り記号、nH は時間数、nM は分数、nS は秒数を表します(たとえば、PT5M は 5 分を、P1M4DT2H5M は 1 か月 4 日 2 時間 5 分を指定します)。

タスクの XML を読み書きする場合、実行時間の制限は Task Scheduler スキーマの ExecutionTimeLimit 要素で指定します。

vtbl 13 HRESULT put_ExecutionTimeLimit(LPWSTR timelimit)

このトリガーによって起動されるタスクの実行が許可される最大時間を取得または設定します。(Put)

timelimitLPWSTRinタスクの最大実行時間を ISO 8601 期間形式の文字列で指定する。

解説(Remarks)

この文字列の形式は PnYnMnDTnHnMnS です。ここで、nY は年数、nM は月数、nD は日数、'T' は日付と時刻の区切り記号、nH は時間数、nM は分数、nS は秒数を表します(たとえば、PT5M は 5 分を、P1M4DT2H5M は 1 か月 4 日 2 時間 5 分を指定します)。

タスクの XML を読み書きする場合、実行時間の制限は Task Scheduler スキーマの ExecutionTimeLimit 要素で指定します。

vtbl 14 HRESULT get_StartBoundary(LPWSTR* pStart)

トリガーが有効化される日時を取得または設定します。(Get)

pStartLPWSTR*inoutトリガーが有効になる開始日時を ISO 8601 形式の文字列で受け取る出力ポインタである。SysFreeString で解放する。

解説(Remarks)

日時は次の形式である必要があります: YYYY-MM-DDTHH:MM:SS(+-)HH:MM。形式の (+-)HH:MM の部分は、協定世界時 (UTC) より進んでいる、または遅れている時間と分を定義します。たとえば、2005 年 10 月 11 日 1:21:17 で UTC より 8 時間遅れているオフセットは、2005-10-11T13:21:17-08:00 と記述します。UTC オフセットに Z を指定した場合(たとえば 2005-10-11T13:21:17Z)、UTC からのオフセットは使用されません。オフセット時間や Z を指定しない場合(たとえば 2005-10-11T13:21:17)、ローカルコンピューターに設定されているタイムゾーンと夏時間の情報が使用されます。オフセットが指定されている場合(時間と分、または Z を使用)、ローカルコンピューターのタイムゾーンおよび夏時間の設定に関係なく、常にその時刻とオフセットが使用されます。

タスクの XML を読み書きする場合、トリガーの開始境界は Task Scheduler スキーマの StartBoundary 要素で指定します。

vtbl 15 HRESULT put_StartBoundary(LPWSTR start)

トリガーが有効化される日時を取得または設定します。(Put)

startLPWSTRinトリガーが有効になる開始日時を ISO 8601 形式の文字列で指定する。

解説(Remarks)

日時は次の形式である必要があります: YYYY-MM-DDTHH:MM:SS(+-)HH:MM。形式の (+-)HH:MM の部分は、協定世界時 (UTC) より進んでいる、または遅れている時間と分を定義します。たとえば、2005 年 10 月 11 日 1:21:17 で UTC より 8 時間遅れているオフセットは、2005-10-11T13:21:17-08:00 と記述します。UTC オフセットに Z を指定した場合(たとえば 2005-10-11T13:21:17Z)、UTC からのオフセットは使用されません。オフセット時間や Z を指定しない場合(たとえば 2005-10-11T13:21:17)、ローカルコンピューターに設定されているタイムゾーンと夏時間の情報が使用されます。オフセットが指定されている場合(時間と分、または Z を使用)、ローカルコンピューターのタイムゾーンおよび夏時間の設定に関係なく、常にその時刻とオフセットが使用されます。

タスクの XML を読み書きする場合、トリガーの開始境界は Task Scheduler スキーマの StartBoundary 要素で指定します。

vtbl 16 HRESULT get_EndBoundary(LPWSTR* pEnd)

トリガーが無効化される日時を取得または設定します。(Get)

pEndLPWSTR*inoutトリガーが無効になる終了日時を ISO 8601 形式の文字列で受け取る出力ポインタである。SysFreeString で解放する。

解説(Remarks)

日時は次の形式である必要があります: YYYY-MM-DDTHH:MM:SS(+-)HH:MM。形式の (+-)HH:MM の部分は、協定世界時 (UTC) より進んでいる、または遅れている時間と分を定義します。たとえば、2005 年 10 月 11 日 1:21:17 で UTC より 8 時間遅れているオフセットは、2005-10-11T13:21:17-08:00 と記述します。UTC オフセットに Z を指定した場合(たとえば 2005-10-11T13:21:17Z)、UTC からのオフセットは使用されません。オフセット時間や Z を指定しない場合(たとえば 2005-10-11T13:21:17)、ローカルコンピューターに設定されているタイムゾーンと夏時間の情報が使用されます。オフセットが指定されている場合(時間と分、または Z を使用)、ローカルコンピューターのタイムゾーンおよび夏時間の設定に関係なく、常にその時刻とオフセットが使用されます。

タスクの XML を読み書きする場合、トリガーの終了境界は Task Scheduler スキーマの EndBoundary 要素で指定します。

vtbl 17 HRESULT put_EndBoundary(LPWSTR end)

トリガーが無効化される日時を取得または設定します。(Put)

endLPWSTRinトリガーが無効になる終了日時を ISO 8601 形式の文字列で指定する。

解説(Remarks)

日時は次の形式である必要があります: YYYY-MM-DDTHH:MM:SS(+-)HH:MM。形式の (+-)HH:MM の部分は、協定世界時 (UTC) より進んでいる、または遅れている時間と分を定義します。たとえば、2005 年 10 月 11 日 1:21:17 で UTC より 8 時間遅れているオフセットは、2005-10-11T13:21:17-08:00 と記述します。UTC オフセットに Z を指定した場合(たとえば 2005-10-11T13:21:17Z)、UTC からのオフセットは使用されません。オフセット時間や Z を指定しない場合(たとえば 2005-10-11T13:21:17)、ローカルコンピューターに設定されているタイムゾーンと夏時間の情報が使用されます。オフセットが指定されている場合(時間と分、または Z を使用)、ローカルコンピューターのタイムゾーンおよび夏時間の設定に関係なく、常にその時刻とオフセットが使用されます。

タスクの XML を読み書きする場合、トリガーの終了境界は Task Scheduler スキーマの EndBoundary 要素で指定します。

vtbl 18 HRESULT get_Enabled(VARIANT_BOOL* pEnabled)

トリガーが有効かどうかを示すブール値を取得または設定します。(Get)

pEnabledVARIANT_BOOL*inoutトリガーが有効かどうかを受け取る VARIANT_BOOL へのポインタである。

解説(Remarks)

タスクの XML を読み書きする場合、enabled プロパティは Task Scheduler スキーマの Enabled 要素を使用して指定します。

vtbl 19 HRESULT put_Enabled(VARIANT_BOOL enabled)

トリガーが有効かどうかを示すブール値を取得または設定します。(Put)

enabledVARIANT_BOOLinトリガーの有効・無効を指定する VARIANT_BOOL である。

解説(Remarks)

タスクの XML を読み書きする場合、enabled プロパティは Task Scheduler スキーマの Enabled 要素を使用して指定します。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_ITrigger "{09941815-EA89-4B5B-89E0-2A773801FAC3}"
#usecom global ITrigger IID_ITrigger "{}"
#comfunc global ITrigger_get_Type                7 var
#comfunc global ITrigger_get_Id                  8 var
#comfunc global ITrigger_put_Id                  9 wstr
#comfunc global ITrigger_get_Repetition          10 sptr
#comfunc global ITrigger_put_Repetition          11 sptr
#comfunc global ITrigger_get_ExecutionTimeLimit  12 var
#comfunc global ITrigger_put_ExecutionTimeLimit  13 wstr
#comfunc global ITrigger_get_StartBoundary       14 var
#comfunc global ITrigger_put_StartBoundary       15 wstr
#comfunc global ITrigger_get_EndBoundary         16 var
#comfunc global ITrigger_put_EndBoundary         17 wstr
#comfunc global ITrigger_get_Enabled             18 var
#comfunc global ITrigger_put_Enabled             19 int
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。
; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。