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

IEnumSTATPROPSTG

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

公式ドキュメント

IEnumSTATPROPSTG インターフェースは、プロパティセット内のプロパティに関する統計データを含む STATPROPSTG 構造体の配列を反復処理します。

メソッド 4

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

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

IEnumSTATPROPSTG::Next メソッドは、列挙シーケンス内で続いて現れる、指定された数の STATPROPSTG 構造体を取得します。

celtDWORDin要求する STATPROPSTG 構造体の数。
rgeltSTATPROPSTG*out返される STATPROPSTG 構造体の配列。
pceltFetchedDWORD*outoptionalrgelt パラメーターで取得された STATPROPSTG 構造体の数。

戻り値

このメソッドは次の戻り値をサポートします。

リターンコード 説明
S_OK
 返される STATPROPSTG 構造体の数は、celt パラメーターで指定された数と等しくなります。
S_FALSE
 返される STATPROPSTG 構造体の数は、celt パラメーターで指定された数より少なくなります。
vtbl 4 HRESULT Skip(DWORD celt)

IEnumSTATPROPSTG::Skip メソッドは、列挙シーケンス内で指定された数の STATPROPSTG 構造体をスキップします。

celtDWORDinスキップする STATPROPSTG 構造体の数。

戻り値

このメソッドは次の戻り値をサポートします。

解説(Remarks)

celt パラメーターに正の値を指定すると、STATPROPSTG 構造体の列挙内で前方にスキップします。celt パラメーターに負の値を指定すると、STATPROPSTG 構造体の列挙内で後方にスキップします。

vtbl 5 HRESULT Reset()

IEnumSTATPROPSTG::Reset メソッドは、列挙シーケンスを STATPROPSTG 構造体配列の先頭にリセットします。

戻り値

このメソッドは S_OK 戻り値をサポートします。

リターンコード 説明
S_OK
 列挙シーケンスが列挙の先頭に正常にリセットされました。
vtbl 6 HRESULT Clone(IEnumSTATPROPSTG** ppenum)

IEnumSTATPROPSTG::Clone メソッドは、現在の STATPROPSTG 構造体列挙子と同じ列挙状態を持つ列挙子を作成します。

ppenumIEnumSTATPROPSTG**out

IEnumSTATPROPSTG インターフェースポインターを受け取る変数へのポインター。

メソッドが失敗した場合、ppenum パラメーターの値は未定義です。

戻り値

このメソッドは次の戻り値をサポートします。

リターンコード 説明
E_INVALIDARG
 ppenum パラメーターが NULL です。
E_OUTOFMEMORY
 メモリが不足しています。
E_UNEXPECTED
 予期しない例外が発生しました。
出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IEnumSTATPROPSTG "{00000139-0000-0000-C000-000000000046}"
#usecom global IEnumSTATPROPSTG IID_IEnumSTATPROPSTG "{}"
#comfunc global IEnumSTATPROPSTG_Next   3 int,var,var
#comfunc global IEnumSTATPROPSTG_Skip   4 int
#comfunc global IEnumSTATPROPSTG_Reset  5
#comfunc global IEnumSTATPROPSTG_Clone  6 sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。