ホーム › Media.DirectShow.Tv › IComponents

IComponents

COMIDispatch (デュアル)

📘 Microsoft Learn (日本語) · English

✅ IDispatch を実装(デュアルインターフェース)。HSP では comobj 経由でメソッド名による遅延バインド呼び出しができます(vtableインデックス不要)。

IID39a48091-fffe-4182-a161-3ff802640e26継承元IDispatch呼び出し名前(IDispatch) または vtbl自前メソッド開始 vtbl7

公式ドキュメント

IComponents インターフェイスは、コンポーネントのコレクションを表します。

解説(Remarks)

このインターフェイスのインターフェイス識別子 (IID) を宣言するには、__uuidof 演算子を使用します: __uuidof(IComponents)。

メソッド 8

vtbl = vtable インデックス(0始まり)。IDispatch 実装のため HSP ではメソッド名でも呼べます(上記)。低レベルの index 呼び出し用に vtbl も掲載。0〜2 は IUnknown。

vtbl 7 HRESULT get_Count(INT* Count)

get_Count メソッドは、コレクション内の Component オブジェクトの数を取得します。

Count

INT*

out

コンポーネントの数を受け取る long 型の変数へのポインター。

戻り値

成功した場合は S_OK を返します。メソッドが失敗した場合は、標準の COM IErrorInfo インターフェイスを使用してエラー情報を取得できます。

vtbl 8 HRESULT get__NewEnum(IEnumVARIANT** ppNewEnum)

get__NewEnum 列挙メソッドは、Automation クライアントでの For...Each ループをサポートします。

ppNewEnum

IEnumVARIANT**

out

列挙を受け取る IEnumVARIANT インターフェイスポインターのアドレス。

戻り値

成功した場合は S_OK を返します。メソッドが失敗した場合は、標準の COM IErrorInfo インターフェイスを使用してエラー情報を取得できます。

解説(Remarks)

このメソッドは、スクリプトや Visual Basic のアプリケーションが For...Each ループでコレクションを反復処理できるように提供されています。C++ アプリケーションでは IComponents::EnumComponents メソッドを使用してください。

返される IEnumVARIANT インターフェイスはスレッドセーフではありません。主に Automation クライアントでの使用を想定しているためです。クライアントは、複数のスレッドからこのインターフェイスのメソッドを呼び出さないでください。

vtbl 9 HRESULT EnumComponents(IEnumComponents** ppNewEnum)

EnumComponents メソッドは、コレクション内のコンポーネントの列挙子を返します。

ppNewEnum

IEnumComponents**

out

IEnumComponents インターフェイスポインターを受け取る変数のアドレス。

戻り値

成功した場合は S_OK を返します。メソッドが失敗した場合は、標準の COM IErrorInfo インターフェイスを使用してエラー情報を取得できます。

解説(Remarks)

メソッドが成功すると、IEnumComponents インターフェイスの参照カウントが残ります。呼び出し元は、このインターフェイスを解放する必要があります。

vtbl 10 HRESULT get_Item(VARIANT Index, IComponent** ppComponent)

get_Item メソッドは、呼び出し元がインデックスによってコンポーネントにアクセスできるようにします。

Index	VARIANT	in	コレクション内の 0 から始まるインデックスを指定する VARIANT 型の変数。
ppComponent	IComponent**	out	指定されたインデックスにある Component オブジェクトを受け取る IComponent インターフェイスポインターのアドレス。

戻り値

成功した場合は S_OK を返します。メソッドが失敗した場合は、標準の COM IErrorInfo インターフェイスを使用してエラー情報を取得できます。

vtbl 11 HRESULT Add(IComponent* Component, VARIANT* NewIndex)

Add メソッドは、Component オブジェクトをコレクションに追加します。

Component	IComponent*	in	追加する Component オブジェクトへのポインター。
NewIndex	VARIANT*	out	Component オブジェクトが追加された後のインデックスを受け取る VARIANT へのポインター。

戻り値

成功した場合は S_OK を返します。メソッドが失敗した場合は、標準の COM IErrorInfo インターフェイスを使用してエラー情報を取得できます。

vtbl 12 HRESULT Remove(VARIANT Index)

Remove メソッドは、Component オブジェクトをコレクションから削除します。

Index

VARIANT

削除する Component オブジェクトのインデックス番号を指定する VARIANT 型の変数。

戻り値

成功した場合は S_OK を返します。メソッドが失敗した場合は、標準の COM IErrorInfo インターフェイスを使用してエラー情報を取得できます。

vtbl 13 HRESULT Clone(IComponents** NewList)

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

NewList

IComponents**

out

新しい Components オブジェクトに設定される IComponents インターフェイスポインターのアドレス。

戻り値

成功した場合は S_OK を返します。メソッドが失敗した場合は、標準の COM IErrorInfo インターフェイスを使用してエラー情報を取得できます。

vtbl 14 HRESULT put_Item(VARIANT Index, IComponent* ppComponent)

put_Item メソッドは、指定されたインデックスで識別される項目を置き換えて、コンポーネントをコレクションに挿入します。

Index	VARIANT	in	コンポーネントに割り当てるインデックスを指定します。このパラメーターは VARIANT 型の値です。
ppComponent	IComponent*	in	コンポーネントオブジェクトの IComponent インターフェイスへのポインター。メソッドはコンポーネントのクローンを作成し、そのクローンをコレクションに挿入します。

戻り値

成功した場合は S_OK を返します。メソッドが失敗した場合は、標準の COM IErrorInfo インターフェイスを使用してエラー情報を取得できます。

解説(Remarks)

このメソッドを使用すると、クライアントはコレクション内の既存の項目を置き換えることができます。

コレクションに n 個の項目が含まれている場合、有効なインデックスは 0 から n-1 の範囲です。コレクション内の項目数を確認するには、get_Count を呼び出します。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IComponents "{39A48091-FFFE-4182-A161-3FF802640E26}"
#usecom global IComponents IID_IComponents "{809B6661-94C4-49E6-B6EC-3F0F862215AA}"
#comfunc global IComponents_get_Count       7 var
#comfunc global IComponents_get__NewEnum    8 sptr
#comfunc global IComponents_EnumComponents  9 sptr
#comfunc global IComponents_get_Item        10 int,sptr
#comfunc global IComponents_Add             11 sptr,var
#comfunc global IComponents_Remove          12 int
#comfunc global IComponents_Clone           13 sptr
#comfunc global IComponents_put_Item        14 int,sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※#usecom 末尾は CoCreateInstance 用のクラスID(コクラスCLSID, SDKから自動取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。
; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。#define global IID_IComponents "{39A48091-FFFE-4182-A161-3FF802640E26}"
#usecom global IComponents IID_IComponents "{809B6661-94C4-49E6-B6EC-3F0F862215AA}"
#comfunc global IComponents_get_Count       7 sptr
#comfunc global IComponents_get__NewEnum    8 sptr
#comfunc global IComponents_EnumComponents  9 sptr
#comfunc global IComponents_get_Item        10 int,sptr
#comfunc global IComponents_Add             11 sptr,sptr
#comfunc global IComponents_Remove          12 int
#comfunc global IComponents_Clone           13 sptr
#comfunc global IComponents_put_Item        14 int,sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※#usecom 末尾は CoCreateInstance 用のクラスID(コクラスCLSID, SDKから自動取得)。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。
; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。