Win32 API 日本語リファレンス
ホームDevices.Tapi › ITTerminalSupport2

ITTerminalSupport2

COMIDispatch (デュアル)
IDispatch を実装(デュアルインターフェース)。HSP では comobj 経由でメソッド名による遅延バインド呼び出しができます(vtableインデックス不要)。
IIDf3eb39bc-1b1f-4e99-a0c0-56305c4dd591継承元ITTerminalSupport呼び出し名前(IDispatch) または vtbl自前メソッド開始 vtbl13

公式ドキュメント

ITTerminalSupport2 インターフェイスは ITTerminalSupport インターフェイスから派生します。ITTerminalSupport2 は、C、C++、およびスクリプトアプリケーションからプラグイン可能なターミナルクラスおよびスーパークラスに関する情報を取得する機能をサポートします。

メソッド 4

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

vtbl 13 HRESULT get_PluggableSuperclasses(VARIANT* pVariant)

get_PluggableSuperclasses メソッドは、ITPluggableTerminalSuperclassInfo スーパークラス情報インターフェイスポインターのコレクションを返します。

pVariantVARIANT*outITPluggableTerminalSuperclassInfo インターフェイスポインターの ITCollection を格納した VARIANT へのポインター。

戻り値

このメソッドは、次のいずれかの値を返すことができます。

意味
S_OK
メソッドは成功しました。
E_FAIL
メソッドは失敗しました。
E_POINTER
pVariant パラメーターが有効なポインターではありません。

解説(Remarks)

TAPI は、ITTerminalSupport2::get_PluggableSuperclasses によって返される ITPluggableTerminalSuperclassInfo インターフェイスに対して AddRef メソッドを呼び出します。アプリケーションは、 ITPluggableTerminalSuperclassInfo インターフェイスに関連付けられたリソースを解放するために、そのインターフェイスに対して Release を呼び出す必要があります。

vtbl 14 HRESULT EnumeratePluggableSuperclasses(IEnumPluggableSuperclassInfo** ppSuperclassEnumerator)

EnumeratePluggableSuperclasses メソッドは、現在のシステムに登録されているプラグイン可能なターミナルスーパークラスを列挙します。

ppSuperclassEnumeratorIEnumPluggableSuperclassInfo**outIEnumPluggableSuperclassInfo インターフェイスへのポインター。

戻り値

このメソッドは、次のいずれかの値を返すことができます。

意味
S_OK
メソッドは成功しました。
E_FAIL
メソッドは失敗しました。
E_POINTER
ppSuperclassEnumerator パラメーターが有効なポインターではありません。

解説(Remarks)

TAPI は、ITTerminalSupport2::EnumeratePluggableSuperclasses によって返される IEnumPluggableSuperclassInfo インターフェイスに対して AddRef メソッドを呼び出します。アプリケーションは、 IEnumPluggableSuperclassInfo インターフェイスに関連付けられたリソースを解放するために、そのインターフェイスに対して Release を呼び出す必要があります。

vtbl 15 HRESULT get_PluggableTerminalClasses(LPWSTR bstrTerminalSuperclass, INT lMediaType, VARIANT* pVariant)

get_PluggableTerminalClasses メソッドは、ITPluggableTerminalClassInfo ターミナルクラス情報インターフェイスポインターのコレクションを返します。

bstrTerminalSuperclassLPWSTRinターミナルスーパークラスの CLSID の BSTR 表現。
lMediaTypeINTinターミナルクラスがサポートする メディアタイプ のビット単位 OR で結合したリスト。
pVariantVARIANT*outITPluggableTerminalClassInfo インターフェイスポインターの ITCollection を格納した VARIANT へのポインター。

戻り値

このメソッドは、次のいずれかの値を返すことができます。

意味
S_OK
メソッドは成功しました。
E_INVALIDARG
lMediaType パラメーターが無効です。
E_FAIL
メソッドは失敗しました。
E_POINTER
bstrTerminalSuperclass または pVariant パラメーターが有効なポインターではありません。

解説(Remarks)

TAPI は、ITTerminalSupport2::get_PluggableTerminalClasses によって返される ITPluggableTerminalClassInfo インターフェイスに対して AddRef メソッドを呼び出します。アプリケーションは、 ITPluggableTerminalClassInfo インターフェイスに関連付けられたリソースを解放するために、そのインターフェイスに対して Release を呼び出す必要があります。

vtbl 16 HRESULT EnumeratePluggableTerminalClasses(GUID iidTerminalSuperclass, INT lMediaType, IEnumPluggableTerminalClassInfo** ppClassEnumerator)

EnumeratePluggableTerminalClasses メソッドは、指定されたスーパークラスの下に登録されているプラグイン可能なターミナルクラスを列挙します。

iidTerminalSuperclassGUIDinターミナルスーパークラスの CLSID。
lMediaTypeINTinターミナルクラスがサポートする メディアタイプ のビット単位 OR で結合したリスト。
ppClassEnumeratorIEnumPluggableTerminalClassInfo**outIEnumPluggableTerminalClassInfo インターフェイスへのポインター。

戻り値

このメソッドは、次のいずれかの値を返すことができます。

意味
S_OK
メソッドは成功しました。
E_INVALIDARG
lMediaType パラメーターが無効です。
E_FAIL
メソッドは失敗しました。
E_POINTER
ppClassEnumerator パラメーターが有効なポインターではありません。

解説(Remarks)

TAPI は、ITTerminalSupport2::EnumeratePluggableTerminalClasses によって返される IEnumPluggableTerminalClassInfo インターフェイスに対して AddRef メソッドを呼び出します。アプリケーションは、 IEnumPluggableTerminalClassInfo インターフェイスに関連付けられたリソースを解放するために、そのインターフェイスに対して Release を呼び出す必要があります。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_ITTerminalSupport2 "{F3EB39BC-1B1F-4E99-A0C0-56305C4DD591}"
#usecom global ITTerminalSupport2 IID_ITTerminalSupport2 "{}"
#comfunc global ITTerminalSupport2_get_PluggableSuperclasses          13 var
#comfunc global ITTerminalSupport2_EnumeratePluggableSuperclasses     14 sptr
#comfunc global ITTerminalSupport2_get_PluggableTerminalClasses       15 wstr,int,var
#comfunc global ITTerminalSupport2_EnumeratePluggableTerminalClasses  16 int,int,sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。
; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。