ホーム › Media.MediaFoundation › ITocCollection

ITocCollection

COM

📘 Microsoft Learn (日本語) · English

IID23fee831-ae96-42df-b170-25a04847a3ca継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

ITocCollection は目次のコレクションを表します。コレクションに対して目次を追加、取得、削除するためのメソッドを提供します。

メソッド 5

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

vtbl 3 HRESULT GetEntryCount(DWORD* pdwEntryCount)

GetEntryCount メソッドは、コレクション内の目次の数を取得します。

pdwEntryCount

DWORD*

inout

目次の数を受け取る DWORD へのポインター。

戻り値

このメソッドは HRESULT を返します。取り得る値には、以下の表に示すもののほか、それ以外の値も含まれます。

戻り値	説明
S_OK	メソッドが成功しました。

解説(Remarks)

ITocCollection インターフェイスの文脈では、entry(エントリ)という語は個々の目次を指します。この語の意味は、TOC Parser テクノロジの他のインターフェイスの文脈における意味とは異なります。たとえば IToc インターフェイスの文脈では、entry という語は、目次の中で動画ファイルの一区間を表す情報ブロックを指します。

vtbl 4 HRESULT GetEntryByIndex(DWORD dwEntryIndex, IToc** ppToc)

GetEntryByIndex メソッドは、インデックスで指定した目次をコレクションから取得します。

dwEntryIndex	DWORD	in	取得する目次のインデックスを指定します。
ppToc	IToc**	out	目次を表す IToc インターフェイスへのポインターを受け取る変数へのポインター。

戻り値

このメソッドは HRESULT を返します。取り得る値には、以下の表に示すもののほか、それ以外の値も含まれます。

戻り値	説明
S_OK	メソッドが成功しました。

解説(Remarks)

vtbl 5 HRESULT AddEntry(IToc* pToc, DWORD* pdwEntryIndex)

AddEntry メソッドは、個々の目次をコレクションに追加し、追加した目次にインデックスを割り当てます。

pToc	IToc*	in	追加する目次を表す IToc インターフェイスへのポインター。
pdwEntryIndex	DWORD*	inout	追加した目次のインデックスを受け取る DWORD へのポインター。

戻り値

このメソッドは HRESULT を返します。取り得る値には、以下の表に示すもののほか、それ以外の値も含まれます。

戻り値	説明
S_OK	メソッドが成功しました。

解説(Remarks)

vtbl 6 HRESULT AddEntryByIndex(DWORD dwEntryIndex, IToc* pToc)

AddEntryByIndex は、個々の目次をコレクションに追加し、呼び出し元が指定したインデックスをその目次に関連付けます。

dwEntryIndex	DWORD	in	目次に関連付ける、呼び出し元が指定するインデックス。
pToc	IToc*	in	追加する目次を表す IToc インターフェイスへのポインター。

戻り値

このメソッドは HRESULT を返します。取り得る値には、以下の表に示すもののほか、それ以外の値も含まれます。

戻り値	説明
S_OK	メソッドが成功しました。

解説(Remarks)

vtbl 7 HRESULT RemoveEntryByIndex(DWORD dwEntryIndex)

RemoveEntryByIndex メソッドは、インデックスで指定した目次をコレクションから削除します。

dwEntryIndex

DWORD

削除する目次のインデックスを指定します。

戻り値

このメソッドは HRESULT を返します。取り得る値には、以下の表に示すもののほか、それ以外の値も含まれます。

戻り値	説明
S_OK	メソッドが成功しました。

解説(Remarks)

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