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

IEnumContextProps

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

公式ドキュメント

IEnumContextProps (objidlbase.h) インターフェイスは、COM+ オブジェクトコンテキストに関連付けられたコンテキストプロパティを列挙するためのメカニズムを提供します。

メソッド 5

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

vtbl 3 HRESULT Next(DWORD celt, ContextProperty* pContextProperties, DWORD* pceltFetched)

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

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

列挙された項目の配列。

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

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

戻り値

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

vtbl 4 HRESULT Skip(DWORD celt)

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

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

戻り値

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

vtbl 5 HRESULT Reset()

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

戻り値

戻り値は S_OK です。

解説(Remarks)

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

vtbl 6 HRESULT Clone(IEnumContextProps** ppEnumContextProps)

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

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

戻り値

このメソッドは、標準の戻り値 E_INVALIDARG、E_OUTOFMEMORY、E_UNEXPECTED、および S_OK を返すことができます。

vtbl 7 HRESULT Count(DWORD* pcelt)

IEnumContextProps::Count (objidlbase.h) メソッドは、コンテキスト内のコンテキストプロパティの数を取得します。

pceltDWORD*outシーケンス内の項目の数。

戻り値

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