ホーム › Media.DirectShow › IEnumPins

IEnumPins

COM

📘 Microsoft Learn (日本語) · English

IID56a86892-0ad4-11ce-b03a-0020af0ba770継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

フィルター上のピンを列挙します。IBaseFilter::EnumPins メソッドがこのインターフェイスを返します。

メソッド 4

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

vtbl 3 HRESULT Next(DWORD cPins, IPin** ppPins, DWORD* pcFetched)

Next メソッドは、列挙シーケンス内の指定した数のピンを取得します。

cPins	DWORD	in	取得するピンの数。
ppPins	IPin**	out	IPin ポインターが格納される、サイズ cPins の配列。呼び出し元がインターフェイスを解放する必要があります。
pcFetched	DWORD*	outoptional	取得されたピンの数を受け取る変数へのポインター。cPins が 1 の場合は NULL にできます。

戻り値

次の HRESULT 値のいずれかを返します。

Return code	Description
S_FALSE	要求された数のピンを取得できませんでした。
S_OK	成功しました。
E_INVALIDARG	引数が無効です。
E_POINTER	NULL ポインター引数です。
VFW_E_ENUM_OUT_OF_SYNC	フィルターの状態が変化し、列挙子との整合性がなくなりました。

解説(Remarks)

このメソッドは、列挙内の現在の位置から始めて、指定した数のピンへのポインターを取得し、指定した配列に格納します。

メソッドが成功した場合、すべての IPin ポインターは参照カウントが残った状態になります。使用が終わったら必ず解放してください。

ピンの数が変化すると、列挙子はフィルターとの整合性を失い、メソッドは VFW_E_ENUM_OUT_OF_SYNC を返します。列挙子への以前の呼び出しで取得したデータは無効な可能性があるため、破棄してください。IEnumPins::Reset メソッドを呼び出して列挙子を更新します。その後、Next メソッドを安全に呼び出すことができます。

vtbl 4 HRESULT Skip(DWORD cPins)

Skip メソッドは、指定した数のピンをスキップします。

cPins

DWORD

スキップするピンの数。

戻り値

次の HRESULT のいずれかを返します。

Return code	Description
S_FALSE	シーケンスの末尾を越えてスキップしました。
S_OK	成功しました。
VFW_E_ENUM_OUT_OF_SYNC	フィルターの状態が変化し、列挙子との整合性がなくなりました。

解説(Remarks)

ピンの数が変化すると、列挙子はフィルターとの整合性を失い、メソッドは VFW_E_ENUM_OUT_OF_SYNC を返します。列挙子への以前の呼び出しで取得したデータは無効な可能性があるため、破棄してください。IEnumPins::Reset メソッドを呼び出して列挙子を更新します。その後、Skip メソッドを安全に呼び出すことができます。

vtbl 5 HRESULT Reset()

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

戻り値

S_OK を返します。

vtbl 6 HRESULT Clone(IEnumPins** ppEnum)

Clone メソッドは、同じ列挙状態を持つ列挙子のコピーを作成します。

ppEnum

IEnumPins**

out

新しい列挙子の IEnumPins インターフェイスへのポインターを受け取ります。呼び出し元がインターフェイスを解放する必要があります。

戻り値

次の HRESULT のいずれかを返します。

Return code	Description
S_OK	成功しました。
E_OUTOFMEMORY	メモリが不足しています。
E_POINTER	NULL ポインター引数です。
VFW_E_ENUM_OUT_OF_SYNC	フィルターの状態が変化し、列挙子との整合性がなくなりました。

解説(Remarks)

ピンの数が変化すると、列挙子はフィルターとの整合性を失い、メソッドは VFW_E_ENUM_OUT_OF_SYNC を返します。列挙子への以前の呼び出しで取得したデータは無効な可能性があるため、破棄してください。IEnumPins::Reset メソッドを呼び出して列挙子を更新します。その後、Clone メソッドを安全に呼び出すことができます。

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