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

IEnumMediaTypes

COM
IID89c31040-846b-11ce-97d3-00aa0055595a継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

IEnumMediaTypes インターフェイスは、ピンが優先するメディアタイプを列挙します。

メソッド 4

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

vtbl 3 HRESULT Next(DWORD cMediaTypes, AM_MEDIA_TYPE** ppMediaTypes, DWORD* pcFetched)

Next メソッドは、指定した数のメディアタイプを取得します。

cMediaTypesDWORDin取得するメディアタイプの数。
ppMediaTypesAM_MEDIA_TYPE**outAM_MEDIA_TYPE ポインターの配列のアドレス。配列の要素数は cMediaTypes パラメーターで指定します。
pcFetchedDWORD*outoptionalppMediaTypes で返されるメディアタイプの数を受け取ります。cMediaTypes が 1 の場合、このパラメーターは NULL にできます。

戻り値

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

リターンコード 説明
S_FALSE
要求された数のメディアタイプを取得できませんでした。
S_OK
成功しました。
E_INVALIDARG
引数が無効です。
E_POINTER
NULL ポインター引数です。
VFW_E_ENUM_OUT_OF_SYNC
ピンの状態が変化し、列挙子と一致しなくなりました。

解説(Remarks)

呼び出し側は、ppMediaTypesAM_MEDIA_TYPE ポインターの配列を渡します。このメソッドは、cMediaTypes と列挙内に残っているメディアタイプの数のうち、いずれか少ない方に等しい数の AM_MEDIA_TYPE 構造体を割り当てます。割り当てられた構造体の数は pcFetched で返されます。各構造体は DeleteMediaType 関数を呼び出して削除してください。

メディアタイプの集合が変化すると、列挙子は所有元のピンと一致しなくなります。その場合、メソッドは VFW_E_ENUM_OUT_OF_SYNC を返します。列挙子への以前の呼び出しで取得したデータは無効である可能性があるため、破棄してください。IEnumMediaTypes::Reset メソッドを呼び出して列挙子を更新します。その後、Next メソッドを安全に呼び出すことができます。

vtbl 4 HRESULT Skip(DWORD cMediaTypes)

Skip メソッドは、指定した数のメディアタイプをスキップします。

cMediaTypesDWORDinスキップするメディアタイプの数。

戻り値

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

リターンコード 説明
S_FALSE
シーケンスの末尾を越えてスキップしました。
S_OK
成功しました。
VFW_E_ENUM_OUT_OF_SYNC
ピンの状態が変化し、列挙子と一致しなくなりました。

解説(Remarks)

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

vtbl 5 HRESULT Reset()

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

戻り値

S_OK を返します。

vtbl 6 HRESULT Clone(IEnumMediaTypes** ppEnum)

Clone メソッドは、列挙子のコピーを作成します。返されるオブジェクトは、元の列挙子と同じ列挙状態から開始します。

ppEnumIEnumMediaTypes**out新しい列挙子の IEnumMediaTypes インターフェイスへのポインターを受け取ります。呼び出し側はこのインターフェイスを解放する必要があります。

戻り値

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

リターンコード 説明
S_OK
成功しました。
E_OUTOFMEMORY
メモリが不足しています。
E_POINTER
NULL ポインター引数です。
VFW_E_ENUM_OUT_OF_SYNC
ピンの状態が変化し、列挙子と一致しなくなりました。

解説(Remarks)

メディアタイプの集合が変化すると、列挙子はピンと一致しなくなり、メソッドは VFW_E_ENUM_OUT_OF_SYNC を返します。列挙子への以前の呼び出しで取得したデータは無効である可能性があるため、破棄してください。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_IEnumMediaTypes "{89C31040-846B-11CE-97D3-00AA0055595A}"
#usecom global IEnumMediaTypes IID_IEnumMediaTypes "{}"
#comfunc global IEnumMediaTypes_Next   3 int,var,var
#comfunc global IEnumMediaTypes_Skip   4 int
#comfunc global IEnumMediaTypes_Reset  5
#comfunc global IEnumMediaTypes_Clone  6 sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。