ホーム › Storage.FileServerResourceManager › IFsrmCollection

IFsrmCollection

COMIDispatch (デュアル)

📘 Microsoft Learn (日本語) · English

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

IIDf76fbf3b-8ddd-4b42-b05a-cb1c3ff1fee8継承元IDispatch呼び出し名前(IDispatch) または vtbl自前メソッド開始 vtbl7

公式ドキュメント

FSRM オブジェクトのコレクションを定義します。

メソッド 7

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

vtbl 7 HRESULT get__NewEnum(IUnknown** unknown)

コレクション内の項目を列挙するための新しい IEnumVARIANT 列挙子の IUnknown ポインターを取得します。

unknown

IUnknown**

out

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

解説(Remarks)

C/C++ のユーザーは、このメソッドを使用してコレクション内の項目を列挙します。 IUnknown インターフェースの QueryInterface を呼び出して IEnumVARIANT インターフェースを取得してください。コレクションの項目を列挙するには IEnumVARIANT::Next メソッドを使用します。項目は VARIANT 値として返されます。

コレクションにインターフェースが含まれている場合、バリアント型は VT_DISPATCH です。バリアントの pdispVal メンバーに対して QueryInterface メソッドを呼び出すことで、目的のオブジェクトのインターフェースを取得できます。たとえば、コレクションにレポートオブジェクトが含まれている場合は、pdispVal メンバーに対して IFsrmReport インターフェースを照会します。

項目が HRESULT 値の場合、バリアント型は VT_I4 です。HRESULT 値を取得するには、バリアントの lVal メンバーを使用します。

vtbl 8 HRESULT get_Item(INT index, VARIANT* item)

要求された項目をコレクションから取得します。(IFsrmCollection.get_Item)

index	INT	in	取得する項目の 1 始まりのインデックスを指定する。
item	VARIANT*	out	指定インデックスの項目を格納した VARIANT を受け取るポインタである。

解説(Remarks)

項目がインターフェースの場合、バリアント型は VT_DISPATCH です。バリアントの pdispVal メンバーに対して QueryInterface メソッドを呼び出すことで、目的のオブジェクトのインターフェースを取得できます。

項目が HRESULT 値の場合、バリアント型は VT_I4 です。HRESULT 値を取得するには、バリアントの lVal メンバーを使用します。

例

例については、ファイルスクリーンの更新およびファイルの分類を参照してください。

vtbl 9 HRESULT get_Count(INT* count)

コレクション内の項目数を取得します。(IFsrmCollection.get_Count)

count

INT*

out

コレクションに含まれる項目数を受け取るポインタである。

vtbl 10 HRESULT get_State(FsrmCollectionState* state)

コレクションの状態を取得します。

state

FsrmCollectionState*

out

コレクションの現在の状態(FsrmCollectionState)を受け取るポインタである。

vtbl 11 HRESULT Cancel()

オブジェクトが非同期的に収集される場合に、オブジェクトの収集をキャンセルします。

戻り値

このメソッドは次の戻り値を返します。

vtbl 12 HRESULT WaitForCompletion(INT waitSeconds, VARIANT_BOOL* completed)

非同期コレクションがオブジェクトの収集に要する時間を制限します。

waitSeconds	INT	in	コレクションがオブジェクトの収集を完了するまで待機する秒数です。無期限に待機するには、このパラメーターに –1 を設定します。
completed	VARIANT_BOOL*	out	指定された時間内にコレクションがオブジェクトの収集を完了した場合は VARIANT_TRUE、それ以外の場合は VARIANT_FALSE です。

戻り値

このメソッドはサポートされておらず、常に S_OK を返します。

vtbl 13 HRESULT GetById(GUID id, VARIANT* entry)

指定されたオブジェクトをコレクションから取得します。

id	GUID	in	コレクションから取得するオブジェクトを識別します。
entry	VARIANT*	out	取得されたオブジェクトを格納する VARIANT です。バリアント型は VT_DISPATCH です。オブジェクトの IDispatch インターフェースにアクセスするには、pdispVal メンバーを使用します。

戻り値

このメソッドは次の戻り値を返します。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IFsrmCollection "{F76FBF3B-8DDD-4B42-B05A-CB1C3FF1FEE8}"
#usecom global IFsrmCollection IID_IFsrmCollection "{}"
#comfunc global IFsrmCollection_get__NewEnum       7 sptr
#comfunc global IFsrmCollection_get_Item           8 int,var
#comfunc global IFsrmCollection_get_Count          9 var
#comfunc global IFsrmCollection_get_State          10 var
#comfunc global IFsrmCollection_Cancel             11
#comfunc global IFsrmCollection_WaitForCompletion  12 int,var
#comfunc global IFsrmCollection_GetById            13 int,var
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。
; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。#define global IID_IFsrmCollection "{F76FBF3B-8DDD-4B42-B05A-CB1C3FF1FEE8}"
#usecom global IFsrmCollection IID_IFsrmCollection "{}"
#comfunc global IFsrmCollection_get__NewEnum       7 sptr
#comfunc global IFsrmCollection_get_Item           8 int,sptr
#comfunc global IFsrmCollection_get_Count          9 sptr
#comfunc global IFsrmCollection_get_State          10 sptr
#comfunc global IFsrmCollection_Cancel             11
#comfunc global IFsrmCollection_WaitForCompletion  12 int,sptr
#comfunc global IFsrmCollection_GetById            13 int,sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。
; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。