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

IEnumString

COM
📘 Microsoft Learn (日本語) · English
IID00000101-0000-0000-c000-000000000046継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

IEnumString (objidlbase.h) インターフェイスは文字列を列挙します。LPWSTR は、ゼロ終端されたワイド文字(Unicode 文字)の文字列へのポインターを示す型です。

メソッド 4

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

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

IEnumString::Next (objidlbase.h) メソッドは、列挙シーケンス内の指定された数の項目を取得します。

celtDWORDin取得する項目の数。シーケンスに残っている項目が要求された数より少ない場合、このメソッドは残りの要素を取得します。
rgeltLPWSTR*out

列挙された項目の配列。

列挙子はメモリの割り当てを担当し、呼び出し側はその解放を担当します。celt が 1 より大きい場合、呼び出し側は解放すべきポインターの数を知るために、pceltFetched に NULL でないポインターも渡す必要があります。

pceltFetchedDWORD*outoptional取得された項目の数。このパラメーターは常に、要求された項目数以下になります。

戻り値

要求された数の項目を取得できた場合、戻り値は S_OK です。そうでない場合は S_FALSE です。

vtbl 4 HRESULT Skip(DWORD celt)

IEnumString::Skip (objidlbase.h) メソッドは、列挙シーケンス内の指定された数の項目をスキップします。

celtDWORDinスキップする項目の数。

戻り値

要求された数の項目をスキップできた場合、戻り値は S_OK です。そうでない場合は S_FALSE です。

vtbl 5 HRESULT Reset()

IEnumString::Reset (objidlbase.h) メソッドは、列挙シーケンスを先頭にリセットします。

戻り値

戻り値は S_OK です。

解説(Remarks)

リセット操作の完了後に同じオブジェクトの集合が列挙される保証はありません。静的なコレクションは先頭にリセットされますが、ディレクトリ内のファイルなど一部のコレクションでは、この条件を保証するのが高コストになりすぎる場合があります。

vtbl 6 HRESULT Clone(IEnumString** ppenum)

IEnumString::Clone (objidlbase.h) メソッドは、現在の列挙子と同じ列挙状態を持つ新しい列挙子を作成します。

ppenumIEnumString**out複製された列挙子オブジェクトへのポインター。

戻り値

このメソッドは、標準の戻り値 E_INVALIDARG、E_OUTOFMEMORY、E_UNEXPECTED、および 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_IEnumString "{00000101-0000-0000-C000-000000000046}"
#usecom global IEnumString IID_IEnumString "{}"
#comfunc global IEnumString_Next   3 int,var,var
#comfunc global IEnumString_Skip   4 int
#comfunc global IEnumString_Reset  5
#comfunc global IEnumString_Clone  6 sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。