Win32 API 日本語リファレンス
ホームMedia.DirectShow › IEnumPIDMap

IEnumPIDMap

COM
IIDafb6c2a2-2c41-11d3-8a60-0000f81e0e4a継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

IEnumPIDMap インターフェースは、パケット ID (PID) マップのコレクションを列挙します。

メソッド 4

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

vtbl 3 HRESULT Next(DWORD cRequest, PID_MAP* pPIDMap, DWORD* pcReceived)

Next メソッドは、コレクション内の次の n 個の要素を取得します。

cRequestDWORDin取得する要素の数。
pPIDMapPID_MAP*inout呼び出し側が割り当てた、cRequest 個の要素を格納する配列のアドレス。この配列には、PID マッピングを記述する PID_MAP 構造体が格納されます。
pcReceivedDWORD*out実際に取得された要素の数を受け取る変数へのポインター。このパラメーターに NULL を指定することはできません。cRequest が 0 の場合、このパラメーターはコレクション内の項目の総数を受け取ります。

戻り値

HRESULT 値を返します。取り得る値には次のものがあります。

戻り値 説明
E_INVALIDARG
引数が無効です。pPidMap および pcReceivedNULL を指定することはできません。
S_FALSE
コレクションの末尾に達しました。
S_OK
成功しました。
vtbl 4 HRESULT Skip(DWORD cRecords)

Skip メソッドは、コレクション内の指定された数の要素をスキップします。

cRecordsDWORDinスキップする要素の数を指定します。

戻り値

HRESULT 値を返します。取り得る値には次のものがあります。

戻り値 説明
S_FALSE
コレクションの末尾に達しました。
S_OK
成功しました。
vtbl 5 HRESULT Reset()

Reset メソッドは、イテレーターをコレクションの先頭に移動します。

戻り値

成功した場合は S_OK を返します。メソッドが失敗した場合は、HRESULT エラーコードが返されます。

vtbl 6 HRESULT Clone(IEnumPIDMap** ppIEnumPIDMap)

Clone メソッドは、コレクションのコピーを作成します。

ppIEnumPIDMapIEnumPIDMap**out新しいコレクションを表す IEnumPIDMap インターフェースポインターを受け取ります。呼び出し側はこのインターフェースを解放する必要があります。

戻り値

HRESULT 値を返します。取り得る値には次のものがあります。

戻り値 説明
E_INVALIDARG
引数が無効です。ppIEnumPIDMapNULL を指定することはできません。
E_OUTOFMEMORY
メモリが不足しています。
S_OK
成功しました。

解説(Remarks)

呼び出し側は、返された IEnumPIDMap インターフェースを解放する必要があります。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IEnumPIDMap "{AFB6C2A2-2C41-11D3-8A60-0000F81E0E4A}"
#usecom global IEnumPIDMap IID_IEnumPIDMap "{}"
#comfunc global IEnumPIDMap_Next   3 int,var,var
#comfunc global IEnumPIDMap_Skip   4 int
#comfunc global IEnumPIDMap_Reset  5
#comfunc global IEnumPIDMap_Clone  6 sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。