ホーム › Media.DirectShow.Tv › ICAT

ICAT

COM

📘 Microsoft Learn (日本語) · English

IID7c6995fb-2a31-4bd7-953e-b1ad7fb7d31c継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

このトピックは、Microsoft Windows XP Media Center Edition 2005 用 Update Rollup 2 以降に適用されます。

メソッド 9

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

vtbl 3 HRESULT Initialize(ISectionList* pSectionList, IMpeg2Data* pMPEGData)

このトピックは、Microsoft Windows XP Media Center Edition 2005 用 Update Rollup 2 以降に適用されます。

pSectionList	ISectionList*	in	セクションデータを格納する SectionList オブジェクトの ISectionList インターフェースへのポインター。
pMPEGData	IMpeg2Data*	in	MPEG-2 Sections and Tables フィルターの IMpeg2Data インターフェースへのポインター。

戻り値

このメソッドは HRESULT を返します。指定可能な値には次の表に示すものが含まれます。

リターンコード	説明
E_INVALIDARG	引数が無効です。
MPEG2_E_ALREADY_INITIALIZED	オブジェクトは既に初期化されています。
S_OK	メソッドが成功しました。

vtbl 4 HRESULT GetVersionNumber(BYTE* pbVal)

このトピックは、Microsoft Windows XP Media Center Edition 2005 用 Update Rollup 2 以降に適用されます。

pbVal

BYTE*

out

version_number フィールドを受け取ります。

戻り値

このメソッドは HRESULT を返します。指定可能な値には次の表に示すものが含まれます。

リターンコード	説明
E_POINTER	NULL ポインター引数です。
S_OK	メソッドが成功しました。

vtbl 5 HRESULT GetCountOfTableDescriptors(DWORD* pdwVal)

このトピックは、Microsoft Windows XP Media Center Edition 2005 用 Update Rollup 2 以降に適用されます。

pdwVal

DWORD*

out

記述子の数を受け取ります。

戻り値

このメソッドは HRESULT を返します。指定可能な値には次の表に示すものが含まれます。

リターンコード	説明
E_POINTER	NULL ポインター引数です。
S_OK	メソッドが成功しました。

vtbl 6 HRESULT GetTableDescriptorByIndex(DWORD dwIndex, IGenericDescriptor** ppDescriptor)

このトピックは、Microsoft Windows XP Media Center Edition 2005 用 Update Rollup 2 以降に適用されます。

dwIndex	DWORD	in	取得する記述子を 0 から始まるインデックスで指定します。CAT 内のテーブル記述子の数を取得するには、ICAT::GetCountOfTableDescriptors メソッドを呼び出します。
ppDescriptor	IGenericDescriptor**	out	IGenericDescriptor インターフェースへのポインターを受け取ります。このインターフェースを使用して、記述子内の情報を取得します。呼び出し側はインターフェースを解放する必要があります。

戻り値

このメソッドは HRESULT を返します。指定可能な値には次の表に示すものが含まれます。

リターンコード	説明
E_POINTER	NULL ポインター引数です。
MPEG2_E_OUT_OF_BOUNDS	インデックスが範囲外です。
S_OK	メソッドが成功しました。

vtbl 7 HRESULT GetTableDescriptorByTag(BYTE bTag, DWORD* pdwCookie, IGenericDescriptor** ppDescriptor)

このトピックは、Microsoft Windows XP Media Center Edition 2005 用 Update Rollup 2 以降に適用されます。

bTag	BYTE	in	検索対象の記述子タグを指定します。
pdwCookie	DWORD*	inout	記述子リスト内の開始位置を指定する変数へのポインター。このパラメーターは省略可能です。pdwCookie の値が NULL の場合、検索はリスト内の最初の記述子から開始されます。それ以外の場合、検索は pdwCookie で指定された位置から開始されます。メソッドが返るとき、pdwCookie パラメーターには、次に一致する記述子の位置が(存在する場合)格納されます。このパラメーターを使用して記述子リストを反復処理し、特定の記述子タグのすべてのインスタンスを検索できます。
ppDescriptor	IGenericDescriptor**	out	IGenericDescriptor インターフェースへのポインターを受け取ります。このインターフェースを使用して、記述子内の情報を取得します。呼び出し側はインターフェースを解放する必要があります。

戻り値

このメソッドは HRESULT を返します。指定可能な値には次の表に示すものが含まれます。

リターンコード	説明
MPEG2_E_OUT_OF_BOUNDS	インデックスが範囲外です。
MPEG2_E_NOT_PRESENT	指定されたタグが見つかりませんでした。
MPEG2_S_MORE_DATA_AVAILABLE	このレコードには、このタグを持つ記述子がさらに 1 つ以上含まれています。
MPEG2_S_NO_MORE_DATA_AVAILABLE	このレコードには、このタグを持つ記述子はこれ以上含まれていません。
S_OK	メソッドが成功しました。

解説(Remarks)

pdwCookie の値が NULL でない場合、このメソッドは MPEG2_S_NO_MORE_DATA_AVAILABLE または MPEG2_S_MORE_DATA_AVAILABLE を返し、MGT に検索条件に一致する追加のタグが含まれているかどうかを示します。

vtbl 8 HRESULT RegisterForNextTable(HANDLE hNextTableAvailable)

このトピックは、Microsoft Windows XP Media Center Edition 2005 用 Update Rollup 2 以降に適用されます。

hNextTableAvailable

HANDLE

呼び出し側が作成したイベントへのハンドル。next テーブルが到着すると、オブジェクトはこのイベントをシグナル状態にします。イベントがシグナル状態になったら、ICAT::GetNextTable メソッドを呼び出してテーブルを取得します。

戻り値

このメソッドは HRESULT を返します。指定可能な値には次の表に示すものが含まれます。

リターンコード	説明
E_ACCESSDENIED	このテーブルは既に next テーブルです。
E_INVALIDARG	引数が無効です。hNextTableAvailable を NULL にすることはできません。
MPEG2_E_ALREADY_INITIALIZED	メソッドは既に呼び出されています。
S_OK	メソッドが成功しました。

解説(Remarks)

このメソッドは current テーブルにのみ適用されます。それ以外の場合、このメソッドは E_ACCESSDENIED を返します。

vtbl 9 HRESULT GetNextTable(DWORD dwTimeout, ICAT** ppCAT)

このトピックは、Microsoft Windows XP Media Center Edition 2005 用 Update Rollup 2 以降に適用されます。

dwTimeout	DWORD	in	タイムアウト値をミリ秒単位で指定します。フィルターがタイムアウト期間内にデータを受信しない場合、このメソッドは失敗します。
ppCAT	ICAT**	out	ICAT インターフェースへのポインターを受け取ります。呼び出し側はインターフェースを解放する必要があります。

戻り値

このメソッドは HRESULT を返します。指定可能な値には次の表に示すものが含まれます。

リターンコード	説明
E_ACCESSDENIED	このテーブルは current ではありません。
E_FAIL	失敗しました。
S_OK	メソッドが成功しました。

解説(Remarks)

このメソッドは current テーブルにのみ適用されます。それ以外の場合、このメソッドは E_ACCESSDENIED を返します。

vtbl 10 HRESULT RegisterForWhenCurrent(HANDLE hNextTableIsCurrent)

このトピックは、Microsoft Windows XP Media Center Edition 2005 用 Update Rollup 2 以降に適用されます。

hNextTableIsCurrent

HANDLE

呼び出し側が作成したイベントへのハンドル。テーブルが current になると、オブジェクトはこのイベントをシグナル状態にします。

戻り値

このメソッドは HRESULT を返します。指定可能な値には次の表に示すものが含まれます。

リターンコード	説明
E_ACCESSDENIED	このテーブルは既に current テーブルです。
E_INVALIDARG	引数が無効です。hNextTableIsCurrent を NULL にすることはできません。
MPEG2_E_ALREADY_INITIALIZED	メソッドは既に呼び出されています。
S_OK	メソッドが成功しました。

解説(Remarks)

このメソッドは next テーブルにのみ適用されます。それ以外の場合、このメソッドは E_ACCESSDENIED を返します。

vtbl 11 HRESULT ConvertNextToCurrent()

このトピックは、Microsoft Windows XP Media Center Edition 2005 用 Update Rollup 2 以降に適用されます。

戻り値

このメソッドは HRESULT を返します。指定可能な値には次の表に示すものが含まれます。

リターンコード	説明
E_ACCESSDENIED	このテーブルは既に current です。
E_INVALIDARG	RegisterForWhenCurrent メソッドが呼び出されていません。
MPEG2_E_MALFORMED_TABLE	新しい current テーブルの形式が正しくありません。
S_OK	メソッドが成功しました。

解説(Remarks)

このメソッドは、current になった next テーブルにのみ適用されます。このメソッドを呼び出す前に、ICAT::RegisterForWhenCurrent を呼び出し、イベントがシグナル状態になるのを待ちます。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_ICAT "{7C6995FB-2A31-4BD7-953E-B1AD7FB7D31C}"
#usecom global ICAT IID_ICAT "{}"
#comfunc global ICAT_Initialize                  3 sptr,sptr
#comfunc global ICAT_GetVersionNumber            4 var
#comfunc global ICAT_GetCountOfTableDescriptors  5 var
#comfunc global ICAT_GetTableDescriptorByIndex   6 int,sptr
#comfunc global ICAT_GetTableDescriptorByTag     7 int,var,sptr
#comfunc global ICAT_RegisterForNextTable        8 sptr
#comfunc global ICAT_GetNextTable                9 int,sptr
#comfunc global ICAT_RegisterForWhenCurrent      10 sptr
#comfunc global ICAT_ConvertNextToCurrent        11
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。#define global IID_ICAT "{7C6995FB-2A31-4BD7-953E-B1AD7FB7D31C}"
#usecom global ICAT IID_ICAT "{}"
#comfunc global ICAT_Initialize                  3 sptr,sptr
#comfunc global ICAT_GetVersionNumber            4 sptr
#comfunc global ICAT_GetCountOfTableDescriptors  5 sptr
#comfunc global ICAT_GetTableDescriptorByIndex   6 int,sptr
#comfunc global ICAT_GetTableDescriptorByTag     7 int,sptr,sptr
#comfunc global ICAT_RegisterForNextTable        8 sptr
#comfunc global ICAT_GetNextTable                9 int,sptr
#comfunc global ICAT_RegisterForWhenCurrent      10 sptr
#comfunc global ICAT_ConvertNextToCurrent        11
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。