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

ITaskDefinition

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

公式ドキュメント

タスクを構成するすべてのコンポーネント(タスクの設定、トリガー、アクション、登録情報など)を定義します。

解説(Remarks)

タスク用の XML を自分で読み書きする場合、タスク定義は Task Scheduler スキーマの Task 要素を使用して指定します。

例

このインターフェースの詳細とサンプルコードについては、時刻トリガーの例(C++)、イベントトリガーの例(C++)、毎日トリガーの例(C++)、登録トリガーの例(C++)、毎週トリガーの例(C++)、ログオントリガーの例(C++)、または 起動トリガーの例(C++)を参照してください。

メソッド 14

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

vtbl 7 HRESULT get_RegistrationInfo(IRegistrationInfo** ppRegistrationInfo)

タスクの説明、タスクの作成者、タスクが登録された日付など、タスクを記述するために使用される登録情報を取得または設定します。(Get)

ppRegistrationInfoIRegistrationInfo**outタスクの登録情報を表す IRegistrationInfo インターフェイスを受け取るポインタへのポインタである。
vtbl 8 HRESULT put_RegistrationInfo(IRegistrationInfo* pRegistrationInfo)

タスクの説明、タスクの作成者、タスクが登録された日付など、タスクを記述するために使用される登録情報を取得または設定します。(Put)

pRegistrationInfoIRegistrationInfo*inタスクに設定する登録情報を表す IRegistrationInfo インターフェイスへのポインタである。
vtbl 9 HRESULT get_Triggers(ITriggerCollection** ppTriggers)

タスクの開始に使用されるトリガーのコレクションを取得または設定します。(Get)

ppTriggersITriggerCollection**outタスクのトリガーコレクションを表す ITriggerCollection インターフェイスを受け取るポインタへのポインタである。
vtbl 10 HRESULT put_Triggers(ITriggerCollection* pTriggers)

タスクの開始に使用されるトリガーのコレクションを取得または設定します。(Put)

pTriggersITriggerCollection*inタスクに設定するトリガーコレクションを表す ITriggerCollection インターフェイスへのポインタである。
vtbl 11 HRESULT get_Settings(ITaskSettings** ppSettings)

Task Scheduler サービスがタスクをどのように実行するかを定義する設定を取得または設定します。(Get)

ppSettingsITaskSettings**outタスクの設定を表す ITaskSettings インターフェイスを受け取るポインタへのポインタである。
vtbl 12 HRESULT put_Settings(ITaskSettings* pSettings)

Task Scheduler サービスがタスクをどのように実行するかを定義する設定を取得または設定します。(Put)

pSettingsITaskSettings*inタスクに設定する ITaskSettings インターフェイスへのポインタである。
vtbl 13 HRESULT get_Data(LPWSTR* pData)

タスクに関連付けられているデータを取得または設定します。(Get)

pDataLPWSTR*inoutタスクに付随するアプリケーション定義のデータを受け取る文字列ポインタへのポインタである。
vtbl 14 HRESULT put_Data(LPWSTR data)

タスクに関連付けられているデータを取得または設定します。(Put)

dataLPWSTRinタスクに設定するアプリケーション定義のデータを指定する。
vtbl 15 HRESULT get_Principal(IPrincipal** ppPrincipal)

タスクのセキュリティ資格情報を提供する、タスクのプリンシパルを取得または設定します。(Get)

ppPrincipalIPrincipal**outタスクの実行プリンシパル (セキュリティコンテキスト) を表す IPrincipal インターフェイスを受け取るポインタへのポインタである。
vtbl 16 HRESULT put_Principal(IPrincipal* pPrincipal)

タスクのセキュリティ資格情報を提供する、タスクのプリンシパルを取得または設定します。(Put)

pPrincipalIPrincipal*inタスクに設定する実行プリンシパルを表す IPrincipal インターフェイスへのポインタである。
vtbl 17 HRESULT get_Actions(IActionCollection** ppActions)

タスクによって実行されるアクションのコレクションを取得または設定します。(Get)

ppActionsIActionCollection**outタスクが実行するアクションのコレクションを表す IActionCollection インターフェイスを受け取るポインタへのポインタである。
vtbl 18 HRESULT put_Actions(IActionCollection* pActions)

タスクによって実行されるアクションのコレクションを取得または設定します。(Put)

pActionsIActionCollection*inタスクに設定するアクションコレクションを表す IActionCollection インターフェイスへのポインタである。
vtbl 19 HRESULT get_XmlText(LPWSTR* pXml)

タスクの XML 形式の定義を取得または設定します。(Get)

pXmlLPWSTR*inoutタスク定義全体を表す XML テキストを受け取る文字列ポインタへのポインタである。

解説(Remarks)

タスクの XML は Task Scheduler スキーマによって定義されます。タスク XML の例については、毎日トリガーの例(XML)を参照してください。

vtbl 20 HRESULT put_XmlText(LPWSTR xml)

タスクの XML 形式の定義を取得または設定します。(Put)

xmlLPWSTRinタスク定義として設定する XML テキストを指定する。

解説(Remarks)

タスクの XML は Task Scheduler スキーマによって定義されます。タスク XML の例については、毎日トリガーの例(XML)を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_ITaskDefinition "{F5BC8FC5-536D-4F77-B852-FBC1356FDEB6}"
#usecom global ITaskDefinition IID_ITaskDefinition "{}"
#comfunc global ITaskDefinition_get_RegistrationInfo  7 sptr
#comfunc global ITaskDefinition_put_RegistrationInfo  8 sptr
#comfunc global ITaskDefinition_get_Triggers          9 sptr
#comfunc global ITaskDefinition_put_Triggers          10 sptr
#comfunc global ITaskDefinition_get_Settings          11 sptr
#comfunc global ITaskDefinition_put_Settings          12 sptr
#comfunc global ITaskDefinition_get_Data              13 var
#comfunc global ITaskDefinition_put_Data              14 wstr
#comfunc global ITaskDefinition_get_Principal         15 sptr
#comfunc global ITaskDefinition_put_Principal         16 sptr
#comfunc global ITaskDefinition_get_Actions           17 sptr
#comfunc global ITaskDefinition_put_Actions           18 sptr
#comfunc global ITaskDefinition_get_XmlText           19 var
#comfunc global ITaskDefinition_put_XmlText           20 wstr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。
; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。