ホーム › System.Com.Events › IEnumEventObject

IEnumEventObject

COM

📘 Microsoft Learn (日本語) · English

IIDf4a07d63-2e25-11d1-9964-00c04fbbb345継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

COM+ イベントストアに登録されているイベントオブジェクトを列挙します。

メソッド 4

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

vtbl 3 HRESULT Clone(IEnumEventObject** ppInterface)

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

ppInterface

IEnumEventObject**

out

列挙オブジェクト上の IEnumEventObject インターフェイスへのポインターのアドレス。このパラメーターに NULL を指定することはできません。メソッドが失敗した場合、この出力変数の値は未定義です。

戻り値

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

解説(Remarks)

IEnumEventObject へのポインターが返されるとき、その位置はコレクション内の最初のオブジェクトに設定されており、複製元となった列挙オブジェクトの列挙位置ではありません。

vtbl 4 HRESULT Next(DWORD cReqElem, IUnknown** ppInterface, DWORD* cRetElem)

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

cReqElem	DWORD	in	要求する要素の数。シーケンスに残っている要素が要求された数より少ない場合、このメソッドは残りの要素を取得します。
ppInterface	IUnknown**	out	最初に取得したオブジェクト上の IUnknown インターフェイスへのポインターのアドレス。このパラメーターに NULL を指定することはできません。
cRetElem	DWORD*	out	実際に取得された要素の数。このパラメーターに NULL を指定することはできません。

戻り値

このメソッドは、標準の戻り値 E_INVALIDARG、E_POINTER、E_OUTOFMEMORY、E_UNEXPECTED、および E_FAIL に加えて、次の値を返すことがあります。

戻り値	説明
S_OK	要求されたすべての要素が取得されました。
S_FALSE	要求された要素の一部が取得されませんでした。取得された要素の数は pcRetElem に書き込まれました。

vtbl 5 HRESULT Reset()

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

戻り値

このメソッドは、次の値を返すことがあります。

戻り値	説明
S_OK	列挙シーケンスがリセットされました。
S_FALSE	列挙シーケンスはリセットされましたが、列挙子には項目がありません。

解説(Remarks)

S_FALSE の戻り値は、空の列挙を検出するための最適化として利用できます。

シーケンスをリセットするこのメソッドの呼び出しは、コレクションが変更されている可能性があるため、リセット後に同じオブジェクトの集合が列挙されることを保証するものではありません。

vtbl 6 HRESULT Skip(DWORD cSkipElem)

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

cSkipElem

DWORD

スキップする要素の数。

戻り値

このメソッドは、次の値を返すことがあります。

戻り値	説明
S_OK	要求された数の要素がスキップされました。
S_FALSE	スキップされた要素の数が、要求された数と一致しませんでした。

解説(Remarks)

cSkipElem が残りの要素数より大きい場合、Skip は S_FALSE を返すことがあります。この場合、Skip は列挙シーケンスの最後の要素に移動します。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IEnumEventObject "{F4A07D63-2E25-11D1-9964-00C04FBBB345}"
#usecom global IEnumEventObject IID_IEnumEventObject "{}"
#comfunc global IEnumEventObject_Clone  3 sptr
#comfunc global IEnumEventObject_Next   4 int,sptr,var
#comfunc global IEnumEventObject_Reset  5
#comfunc global IEnumEventObject_Skip   6 int
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。#define global IID_IEnumEventObject "{F4A07D63-2E25-11D1-9964-00C04FBBB345}"
#usecom global IEnumEventObject IID_IEnumEventObject "{}"
#comfunc global IEnumEventObject_Clone  3 sptr
#comfunc global IEnumEventObject_Next   4 int,sptr,sptr
#comfunc global IEnumEventObject_Reset  5
#comfunc global IEnumEventObject_Skip   6 int
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。