ホーム › Storage.Imapi › IEnumFsiItems

IEnumFsiItems

COM

📘 Microsoft Learn (日本語) · English

IID2c941fda-975b-59be-a960-9a2a262853a5継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

このインターフェースは、FsiDirectoryItem オブジェクトの子ディレクトリおよびファイル項目を列挙するために使用します。

解説(Remarks)

スクリプトでは EnumFsiItems オブジェクトになります。

メソッド 4

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

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

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

celt	DWORD	in	取得する項目の数。
rgelt	IFsiItem**	out	IFsiItem インターフェースの配列。使用後は rgelt 内の各インターフェースを解放する必要があります。
pceltFetched	DWORD*	out	rgelt に返された要素の数。celt が 1 の場合は、pceltFetched に NULL を指定できます。それ以外の場合は、このメソッドを呼び出す前に pceltFetched の値を 0 に初期化してください。

戻り値

要求した数の要素 (celt) が正常に返された場合、または返された項目数 (pceltFetched) が要求した要素数より少ない場合に、S_OK が返されます。

実装によっては、その他の成功コードが返されることもあります。操作が失敗した場合は次のエラーコードが返されるのが一般的ですが、返される可能性のあるエラー値はこれらに限られません。

戻り値	説明
E_POINTER	ポインターが無効です。値: 0x80004003
E_OUTOFMEMORY	必要なメモリを割り当てられませんでした。値: 0x8007000E
E_INVALIDARG	1 つ以上の引数が無効です。値: 0x80070057

解説(Remarks)

シーケンス内に残っている要素が要求された数より少ない場合は、残りの要素を取得します。

vtbl 4 HRESULT Skip(DWORD celt)

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

celt

DWORD

スキップする項目の数。

戻り値

成功した場合は S_OK が返されますが、実装によってはその他の成功コードが返されることもあります。操作が失敗した場合は次のエラーコードが返されるのが一般的ですが、返される可能性のあるエラー値はこれらに限られません。

戻り値	説明
S_FALSE	要求された要素数より少ない数だけスキップしました。

解説(Remarks)

シーケンス内に残っている要素が、スキップを要求された要素数より少ない場合は、シーケンスの最後の要素を越えた位置までスキップします。

vtbl 5 HRESULT Reset()

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

戻り値

成功した場合は S_OK が返されますが、実装によってはその他の成功コードが返されることもあります。

vtbl 6 HRESULT Clone(IEnumFsiItems** ppEnum)

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

ppEnum

IEnumFsiItems**

out

列挙オブジェクトへのインターフェースポインターを受け取ります。メソッドが失敗した場合、この出力変数の値は未定義です。使用後は ppEnum を解放する必要があります。

戻り値

戻り値	説明
E_POINTER	ポインターが無効です。値: 0x80004003
E_OUTOFMEMORY	必要なメモリを割り当てられませんでした。値: 0x8007000E

解説(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_IEnumFsiItems "{2C941FDA-975B-59BE-A960-9A2A262853A5}"
#usecom global IEnumFsiItems IID_IEnumFsiItems "{}"
#comfunc global IEnumFsiItems_Next   3 int,sptr,var
#comfunc global IEnumFsiItems_Skip   4 int
#comfunc global IEnumFsiItems_Reset  5
#comfunc global IEnumFsiItems_Clone  6 sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。#define global IID_IEnumFsiItems "{2C941FDA-975B-59BE-A960-9A2A262853A5}"
#usecom global IEnumFsiItems IID_IEnumFsiItems "{}"
#comfunc global IEnumFsiItems_Next   3 int,sptr,sptr
#comfunc global IEnumFsiItems_Skip   4 int
#comfunc global IEnumFsiItems_Reset  5
#comfunc global IEnumFsiItems_Clone  6 sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。