ホーム › Storage.Vss › IVssEnumObject

IVssEnumObject

COM

📘 Microsoft Learn (日本語) · English

IIDae1c7110-2f60-11d3-8a39-00c04f72d8e3継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

列挙されたオブジェクトのリストに対して反復処理やその他の操作を行うためのメソッドを含みます。(IVssEnumObject)

メソッド 4

vtbl = vtable インデックス(0始まり)。HSP等からCOMメソッドをインデックス指定で呼ぶ際に使用します。0〜2 は IUnknown。

vtbl 3 HRESULT Next(DWORD celt, VSS_OBJECT_PROP* rgelt, DWORD* pceltFetched)

列挙されたオブジェクトの指定されたリストから、指定された数のオブジェクトを返します。(IVssEnumObject.Next)

celt	DWORD	in	列挙されたオブジェクトのリストから rgelt バッファーに読み取る要素の数。
rgelt	VSS_OBJECT_PROP*	out	返されたオブジェクトを格納する celt 個の VSS_OBJECT_PROP 構造体を受け取る、呼び出し元が割り当てたバッファーのアドレス。このパラメーターは必須であり、NULL にすることはできません。
pceltFetched	DWORD*	out	rgelt バッファーに返された要素の数。

戻り値

このメソッドの有効な戻り値は次のとおりです。

値	説明
S_OK	操作は成功しました。
S_FALSE	返された項目の数が、要求された数より少なくなっています。
E_FAIL	列挙子で内部エラーが発生しました。
E_POINTER	必須のポインターパラメーターのいずれかが NULL です。

解説(Remarks)

複数の VSS_OBJECT_PROP オブジェクトの返却を要求した場合、戻り値 S_FALSE は列挙リストの末尾に達したことを示します。リストに残っている数より多くのオブジェクトが要求された場合、 Next は残りのすべてのオブジェクトを返し、pceltFetched パラメーターに 0 以外の値を設定して S_FALSE を返します。

出力パラメーター rgelt は、celt 個の VSS_OBJECT_PROP 構造体を含む割り当て済みの配列を指している必要があり、NULL にすることはできません。

IVssEnumObject::Next によって rgelt パラメーターが指す VSS_OBJECT_PROP 構造体に返されたシステムリソースを解放するのは、呼び出し元の責任です。

呼び出し元は、返された VSS_OBJECT_PROP 構造体内の VSS_SNAPSHOT_PROP オブジェクトまたは VSS_PROVIDER_PROP オブジェクトのすべての文字列値に対して CoTaskMemFree を使用する必要があります。

VSS_SNAPSHOT_PROP の場合、これは手動で行うこともできますし、ユーティリティ関数 VssFreeSnapshotProperties を使用することもできます。

vtbl 4 HRESULT Skip(DWORD celt)

指定された数のオブジェクトをスキップします。(IVssEnumObject.Skip)

celt

DWORD

列挙されたオブジェクトのリストでスキップする要素の数。

戻り値

このメソッドの有効な戻り値は次のとおりです。

値	説明
S_OK	操作は成功しました。
S_FALSE	項目リストの末尾を超える位置にアクセスしようとしました。
E_FAIL	列挙子で内部エラーが発生しました。

vtbl 5 HRESULT Reset()

IVssEnumObject:Next が最初の列挙オブジェクトから開始するように、列挙子をリセットします。

戻り値

このメソッドの有効な戻り値は次のとおりです。

値	説明
S_OK	操作は成功しました。
E_FAIL	列挙子で内部エラーが発生しました。

vtbl 6 HRESULT Clone(IVssEnumObject** ppenum)

IVssEnumObject 列挙子オブジェクトのコピーを作成することにより、指定された列挙要素リストのコピーを作成します。

ppenum

IVssEnumObject**

inout

IVssEnumObject 列挙子オブジェクトへの二重間接ポインター。このメソッドを呼び出す前に、このパラメーターの値を NULL に設定してください。

戻り値

このメソッドの有効な戻り値は次のとおりです。

値	説明
S_OK	操作は成功しました。
E_FAIL	列挙子で内部エラーが発生しました。
E_OUTOFMEMORY	呼び出し元のメモリまたはその他のシステムリソースが不足しています。
E_POINTER	必須のポインターパラメーターのいずれかが NULL です。

解説(Remarks)

複製された列挙子オブジェクトは、同じ VSS_OBJECT_PROP 構造体のリストを参照します。

呼び出し元は、ppEnum パラメーターが指す IVssEnumObject 列挙子オブジェクトが保持するシステムリソースを解放するために、返されたインターフェイスポインターの Release メソッドを呼び出す必要があります。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IVssEnumObject "{AE1C7110-2F60-11D3-8A39-00C04F72D8E3}"
#usecom global IVssEnumObject IID_IVssEnumObject "{}"
#comfunc global IVssEnumObject_Next   3 int,var,var
#comfunc global IVssEnumObject_Skip   4 int
#comfunc global IVssEnumObject_Reset  5
#comfunc global IVssEnumObject_Clone  6 sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。#define global IID_IVssEnumObject "{AE1C7110-2F60-11D3-8A39-00C04F72D8E3}"
#usecom global IVssEnumObject IID_IVssEnumObject "{}"
#comfunc global IVssEnumObject_Next   3 int,sptr,sptr
#comfunc global IVssEnumObject_Skip   4 int
#comfunc global IVssEnumObject_Reset  5
#comfunc global IVssEnumObject_Clone  6 sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。