ホーム › Storage.VirtualDiskService › IEnumVdsObject

IEnumVdsObject

COM

📘 Microsoft Learn (日本語) · English

IID118610b7-8d94-4030-b5b8-500889788e4e継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

IEnumVdsObject (vdshwprv.h) インターフェイスは、指定された型の VDS オブジェクトの集合を列挙します。

メソッド 4

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

vtbl 3 HRESULT Next(DWORD celt, IUnknown** ppObjectArray, DWORD* pcFetched)

IEnumVdsObject::Next メソッド (vdshwprv.h) は、現在の位置を起点として、列挙内の指定された数のオブジェクトを返します。

celt	DWORD	in	返すオブジェクトの数。
ppObjectArray	IUnknown**	out	IUnknown ポインターの配列のアドレス。VDS が戻り時に初期化します。
pcFetched	DWORD*	out	ULONG のアドレス。VDS が戻り時に ppObjectArray 内のオブジェクトの数で初期化します。

戻り値

このメソッドは、E_INVALIDARG や E_OUTOFMEMORY などの標準的な HRESULT 値、および VDS 固有の戻り値を返すことがあります。また、HRESULT_FROM_WIN32 マクロを使用して変換されたシステムエラーコードを返すこともあります。エラーは VDS 自体、または使用されている基盤の VDS プロバイダーから発生する可能性があります。返される可能性のある値には次のものがあります。

戻り値	説明
S_OK	メソッドは指定された数のオブジェクトを返しました。pcFetched に報告される返されたオブジェクトの数は celt と等しくなり、それらのオブジェクトを返します。
S_FALSE	指定された返すオブジェクトの数が、残っているオブジェクトの数を超えています。残っているすべてのオブジェクトが返され、pcFetched に報告される返されたオブジェクトの数は celt より小さくなり、それらのオブジェクトを返します。

解説(Remarks)

ppObjectArray 配列で返された IUnknown ポインターからオブジェクト固有のインターフェイスポインターを取得するには、IUnknown::QueryInterface メソッドを使用します。

vtbl 4 HRESULT Skip(DWORD celt)

IEnumVdsObject::Skip メソッド (vdshwprv.h) は、列挙内の指定された数のオブジェクトをスキップします。

celt

DWORD

スキップするオブジェクトの数。

戻り値

戻り値	説明
S_OK	メソッドは指定された数のオブジェクトをスキップしました。スキップされたオブジェクトの数は celt と等しくなります。
S_FALSE	指定されたオブジェクトの数が、残っているオブジェクトの数を超えています。残っているオブジェクトの数が celt で指定された数より少ない場合、Skip メソッドは残っているすべてのオブジェクトをスキップします。

vtbl 5 HRESULT Reset()

IEnumVdsObject::Reset メソッド (vdshwprv.h) は、列挙の先頭にリセットします。

戻り値

このメソッドは、E_OUTOFMEMORY などの標準的な HRESULT 値、および VDS 固有の戻り値を返すことがあります。また、HRESULT_FROM_WIN32 マクロを使用して変換されたシステムエラーコードを返すこともあります。エラーは VDS 自体、または使用されている基盤の VDS プロバイダーから発生する可能性があります。返される可能性のある値には次のものがあります。

戻り値	説明
S_OK	列挙がリセットされました。

vtbl 6 HRESULT Clone(IEnumVdsObject** ppEnum)

IEnumVdsObject::Clone メソッド (vdshwprv.h) は、現在の列挙と同じ状態の列挙を作成します。

ppEnum

IEnumVdsObject**

out

IEnumVdsObject ポインターのアドレス。VDS が戻り時に初期化します。呼び出し元はインターフェイスを解放する必要があります。

戻り値

戻り値	説明
S_OK	新しい列挙が作成されました。

解説(Remarks)

このメソッドを使用すると、列挙内のある位置を記録し、後でその位置に戻ることができます。新しく複製された列挙が返されるとき、それは元の列挙シーケンスと同じ位置にあります。ただし、それ以降、複製と元の列挙は独立して動作します。

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