ホーム › System.ComponentServices › IEnumNames

IEnumNames

COM

📘 Microsoft Learn (日本語) · English

IID51372af2-cae7-11cf-be81-00aa00a2fa25継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

名前を列挙します。

メソッド 4

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

vtbl 3 HRESULT Next(DWORD celt, LPWSTR* rgname, DWORD* pceltFetched)

列挙シーケンス内の指定した数の項目を取得します。(IEnumNames.Next)

celt	DWORD	in	要求する名前値の数。
rgname	LPWSTR*	inout	名前値を返す配列。celt パラメーターで指定したサイズ以上である必要があります。
pceltFetched	DWORD*	inout	rgname に返された要素の数、または NULL。

戻り値

このメソッドは、標準の戻り値 E_INVALIDARG、E_POINTER、E_OUTOFMEMORY、E_UNEXPECTED、E_FAIL に加えて、次の値を返すことがあります。

戻り値	説明
S_OK	要求されたすべての要素が正常に取得されました。
S_FALSE	返された要素の数が、celt パラメーターで指定した数より少なくなっています。

vtbl 4 HRESULT Skip(DWORD celt)

列挙シーケンス内の指定した数の項目をスキップします。(IEnumNames.Skip)

celt

DWORD

スキップする要素の数。

戻り値

このメソッドは、標準の戻り値 E_INVALIDARG、E_OUTOFMEMORY、E_UNEXPECTED、E_FAIL に加えて、次の値を返すことがあります。

戻り値	説明
S_OK	要求された数の要素がスキップされました。
S_FALSE	スキップされた要素の数が、要求された数と一致しませんでした。

vtbl 5 HRESULT Reset()

列挙シーケンスを先頭にリセットします。(IEnumNames.Reset)

戻り値

このメソッドは、標準の戻り値 E_INVALIDARG、E_OUTOFMEMORY、E_UNEXPECTED、E_FAIL に加えて、次の値を返すことがあります。

戻り値	説明
S_OK	列挙シーケンスがリセットされました。
S_FALSE	列挙シーケンスはリセットされましたが、列挙子に項目がありません。

解説(Remarks)

S_FALSE の戻り値は、空の列挙を検出するための最適化として利用できます。

シーケンスをリセットするこのメソッドを呼び出しても、コレクションが変更されている可能性があるため、リセット後に同じオブジェクトのセットが列挙されることは保証されません。

vtbl 6 HRESULT Clone(IEnumNames** ppenum)

現在の列挙子と同じ列挙状態を持つ列挙子を作成します。(IEnumNames.Clone)

ppenum

IEnumNames**

out

列挙オブジェクト上の IEnumNames インターフェースへのポインターのアドレス。

戻り値

このメソッドは、標準の戻り値 E_INVALIDARG、E_OUTOFMEMORY、E_UNEXPECTED、E_FAIL、および 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_IEnumNames "{51372AF2-CAE7-11CF-BE81-00AA00A2FA25}"
#usecom global IEnumNames IID_IEnumNames "{}"
#comfunc global IEnumNames_Next   3 int,var,var
#comfunc global IEnumNames_Skip   4 int
#comfunc global IEnumNames_Reset  5
#comfunc global IEnumNames_Clone  6 sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。#define global IID_IEnumNames "{51372AF2-CAE7-11CF-BE81-00AA00A2FA25}"
#usecom global IEnumNames IID_IEnumNames "{}"
#comfunc global IEnumNames_Next   3 int,sptr,sptr
#comfunc global IEnumNames_Skip   4 int
#comfunc global IEnumNames_Reset  5
#comfunc global IEnumNames_Clone  6 sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。