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

IFolderActionCollection

COMIDispatch (デュアル)
IDispatch を実装(デュアルインターフェース)。HSP では comobj 経由でメソッド名による遅延バインド呼び出しができます(vtableインデックス不要)。
IID03837544-098b-11d8-9414-505054503030継承元IDispatch呼び出し名前(IDispatch) または vtbl自前メソッド開始 vtbl7

公式ドキュメント

FolderAction オブジェクトのコレクションを管理します。このインターフェイスを取得するには、IDataManager::FolderActions プロパティにアクセスします。

解説(Remarks)

1 つ以上の IFolderAction インスタンスを追加できます。各インスタンスは、フォルダーアクションが発生するタイミングを決定します。たとえば、あるインスタンスは 1 週目(IFolderAction::Age が 7)にフォルダーアクションを発生させ、もう 1 つのインスタンスは 10 週目(Age が 10)にフォルダーアクションを発生させることができます。

メソッド 8

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

vtbl 7 HRESULT get_Count(DWORD* Count)

コレクション内のフォルダーアクションの数を取得します。

CountDWORD*out現在の要素数を受け取るポインタである。
vtbl 8 HRESULT get_Item(VARIANT Index, IFolderAction** Action)

コレクションから要求されたフォルダーアクションを取得します。

IndexVARIANTin取得する要素のインデックスまたはキーを表す VARIANT を指定する。
ActionIFolderAction**out指定したフォルダアクションを表す IFolderAction を受け取るポインタである。

解説(Remarks)

このプロパティは、オブジェクトの既定のプロパティです。

vtbl 9 HRESULT get__NewEnum(IUnknown** Enum)

列挙へのインターフェイスを取得します。(IFolderActionCollection.get__NewEnum)

EnumIUnknown**outコレクションを反復処理する列挙子(IUnknown)を受け取るポインタである。

解説(Remarks)

このプロパティは C++ プログラマーが使用します。

列挙は、呼び出し時点でのコレクションのスナップショットです。

列挙の項目は、型が VT_UNKNOWN のバリアントです。IFolderAction インターフェイスをクエリするには、バリアントの punkVal メンバーを使用します。

vtbl 10 HRESULT Add(IFolderAction* Action)

コレクションにフォルダーアクションを追加します。

ActionIFolderAction*inoptionalコレクションに追加するアクションの IFolderAction インターフェイス。

戻り値

成功した場合は S_OK を返します。

vtbl 11 HRESULT Remove(VARIANT Index)

指定したインデックスに基づいて、コレクションからフォルダーアクションを削除します。

IndexVARIANTinコレクションから削除するフォルダーアクションの 0 から始まるインデックス。バリアント型は VT_I4VT_UI4、または VT_DISPATCH のいずれかです。

戻り値

成功した場合は S_OK を返します。

解説(Remarks)

バリアント型が VT_DISPATCH の場合は、削除する IFolderAction インターフェイスの IDispatch インターフェイスを渡します。

vtbl 12 HRESULT Clear()

コレクションからすべてのフォルダーアクションを削除します。

戻り値

成功した場合は S_OK を返します。

vtbl 13 HRESULT AddRange(IFolderActionCollection* Actions)

コレクションに 1 つ以上のフォルダーアクションを追加します。

ActionsIFolderActionCollection*inoptionalこのコレクションに追加する 1 つ以上のフォルダーアクションのコレクションを表す IFolderActionCollection インターフェイス。

戻り値

成功した場合は S_OK を返します。

vtbl 14 HRESULT CreateFolderAction(IFolderAction** FolderAction)

フォルダーアクションオブジェクトを作成します。

FolderActionIFolderAction**outデータマネージャーが実行するアクションを記述するために使用する IFolderAction インターフェイス。

戻り値

成功した場合は S_OK を返します。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IFolderActionCollection "{03837544-098B-11D8-9414-505054503030}"
#usecom global IFolderActionCollection IID_IFolderActionCollection "{}"
#comfunc global IFolderActionCollection_get_Count           7 var
#comfunc global IFolderActionCollection_get_Item            8 int,sptr
#comfunc global IFolderActionCollection_get__NewEnum        9 sptr
#comfunc global IFolderActionCollection_Add                 10 sptr
#comfunc global IFolderActionCollection_Remove              11 int
#comfunc global IFolderActionCollection_Clear               12
#comfunc global IFolderActionCollection_AddRange            13 sptr
#comfunc global IFolderActionCollection_CreateFolderAction  14 sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。
; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。