ホーム › System.TaskScheduler › IActionCollection

IActionCollection

COMIDispatch (デュアル)

📘 Microsoft Learn (日本語) · English

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

IID02820e19-7b98-4ed2-b2e8-fdccceff619b継承元IDispatch呼び出し名前(IDispatch) または vtbl自前メソッド開始 vtbl7

公式ドキュメント

タスクによって実行されるアクションを格納します。

解説(Remarks)

タスクの XML を読み書きする際、タスクのアクションはタスクスケジューラースキーマの Actions 要素で指定します。

例

このインターフェイスの詳細とサンプルコードについては、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++) を参照してください。

メソッド 10

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, IAction** ppAction)

コレクションから指定したアクションを取得します。

index	INT	in	取得するアクションの 1 始まりのインデックスを指定する。
ppAction	IAction**	out	指定したインデックスのアクション (IAction) を受け取る出力ポインタである。

解説(Remarks)

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

vtbl 9 HRESULT get__NewEnum(IUnknown** ppEnum)

アクションコレクションのコレクション列挙子を取得します。

ppEnum

IUnknown**

out

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

vtbl 10 HRESULT get_XmlText(LPWSTR* pText)

コレクションの XML 形式のバージョンを取得または設定します。(取得)

pText

LPWSTR*

inout

コレクション内のアクションを表す XML テキストを受け取る出力ポインタである。SysFreeString で解放する。

vtbl 11 HRESULT put_XmlText(LPWSTR text)

コレクションの XML 形式のバージョンを取得または設定します。(設定)

text

LPWSTR

コレクションに設定するアクションを表す XML テキストを指定する。

vtbl 12 HRESULT Create(TASK_ACTION_TYPE type, IAction** ppAction)

新しいアクションを作成してコレクションに追加します。

type

TASK_ACTION_TYPE

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

値	意味
TASK_ACTION_EXEC 0	このアクションはコマンドライン操作を実行します。たとえば、スクリプトの実行、実行可能ファイルの起動、あるいはドキュメント名が指定された場合は、そのドキュメントに関連付けられたアプリケーションを見つけて、そのドキュメントとともにアプリケーションを起動できます。
TASK_ACTION_COM_HANDLER 5	このアクションはハンドラーを起動します。
TASK_ACTION_SEND_EMAIL 6	このアクションはメールメッセージを送信します。
TASK_ACTION_SHOW_MESSAGE 7	このアクションはメッセージボックスを表示します。

ppAction

IAction**

out

新しいアクションを表す IAction インターフェイス。

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

戻り値

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

解説(Remarks)

コレクションには 32 個を超えるアクションを追加できません。

vtbl 13 HRESULT Remove(VARIANT index)

指定したアクションをコレクションから削除します。

index

VARIANT

削除するアクションのインデックス。インデックス番号には LONG 値を使用します。

戻り値

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

解説(Remarks)

IActionCollection::Remove は、無効な引数が指定された場合、E_INVALID_VARIANT ではなく E_INVALIDARG および E_TYPE_MISMATCH を返します。

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

vtbl 14 HRESULT Clear()

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

戻り値

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

vtbl 15 HRESULT get_Context(LPWSTR* pContext)

タスクのプリンシパルの識別子を取得または設定します。(取得)

pContext

LPWSTR*

inout

アクションが実行される際の識別子コンテキストを受け取る出力ポインタである。SysFreeString で解放する。

vtbl 16 HRESULT put_Context(LPWSTR context)

タスクのプリンシパルの識別子を取得または設定します。(設定)

context

LPWSTR

アクションが実行される際の識別子コンテキストを指定する。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IActionCollection "{02820E19-7B98-4ED2-B2E8-FDCCCEFF619B}"
#usecom global IActionCollection IID_IActionCollection "{}"
#comfunc global IActionCollection_get_Count     7 var
#comfunc global IActionCollection_get_Item      8 int,sptr
#comfunc global IActionCollection_get__NewEnum  9 sptr
#comfunc global IActionCollection_get_XmlText   10 var
#comfunc global IActionCollection_put_XmlText   11 wstr
#comfunc global IActionCollection_Create        12 int,sptr
#comfunc global IActionCollection_Remove        13 int
#comfunc global IActionCollection_Clear         14
#comfunc global IActionCollection_get_Context   15 var
#comfunc global IActionCollection_put_Context   16 wstr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。
; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。#define global IID_IActionCollection "{02820E19-7B98-4ED2-B2E8-FDCCCEFF619B}"
#usecom global IActionCollection IID_IActionCollection "{}"
#comfunc global IActionCollection_get_Count     7 sptr
#comfunc global IActionCollection_get_Item      8 int,sptr
#comfunc global IActionCollection_get__NewEnum  9 sptr
#comfunc global IActionCollection_get_XmlText   10 sptr
#comfunc global IActionCollection_put_XmlText   11 wstr
#comfunc global IActionCollection_Create        12 int,sptr
#comfunc global IActionCollection_Remove        13 int
#comfunc global IActionCollection_Clear         14
#comfunc global IActionCollection_get_Context   15 sptr
#comfunc global IActionCollection_put_Context   16 wstr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。
; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。