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

IEnumFORMATETC

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

公式ドキュメント

指定されたデータオブジェクトがサポートする形式とメディアを定義する FORMATETC 構造体を列挙します。

メソッド 4

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

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

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

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

列挙された項目の配列。

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

pceltFetchedDWORD*outoptional取得された項目の数。このパラメータは、要求された項目数以下になります。celt が 1 の場合、このパラメータは NULL にすることができます。

戻り値

要求された数の項目をメソッドが取得した場合、戻り値は S_OK です。それ以外の場合は S_FALSE です。

vtbl 4 HRESULT Skip(DWORD celt)

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

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

戻り値

要求された数の項目をメソッドがスキップした場合、戻り値は S_OK です。それ以外の場合は S_FALSE です。

vtbl 5 HRESULT Reset()

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

戻り値

このメソッドは成功時に S_OK を返します。

解説(Remarks)

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

vtbl 6 HRESULT Clone(IEnumFORMATETC** ppenum)

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

ppenumIEnumFORMATETC**out列挙オブジェクトへのインターフェイスポインタを受け取る IEnumFORMATETC ポインタ変数のアドレス。メソッドが失敗した場合、この出力変数の値は未定義です。

戻り値

このメソッドは成功時に S_OK を返します。その他に返される可能性のある値には次のものがあります。

戻り値 説明
E_UNEXPECTED
 予期しないエラーが発生しました。
E_INVALIDARG
 指定された列挙子が無効です。
E_OUTOFMEMORY
 この操作に利用できるメモリが不足しています。
出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IEnumFORMATETC "{00000103-0000-0000-C000-000000000046}"
#usecom global IEnumFORMATETC IID_IEnumFORMATETC "{}"
#comfunc global IEnumFORMATETC_Next   3 int,var,var
#comfunc global IEnumFORMATETC_Skip   4 int
#comfunc global IEnumFORMATETC_Reset  5
#comfunc global IEnumFORMATETC_Clone  6 sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。