ホーム › Devices.Tapi › ITTerminal

ITTerminal

COMIDispatch (デュアル)

📘 Microsoft Learn (日本語) · English

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

IIDb1efc38a-9355-11d0-835c-00aa003ccabd継承元IDispatch呼び出し名前(IDispatch) または vtbl自前メソッド開始 vtbl7

公式ドキュメント

ITTerminal インターフェイスは、Terminal オブジェクトの基底インターフェイスです。

メソッド 6

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

vtbl 7 HRESULT get_Name(LPWSTR* ppName)

get_Name メソッドは、ターミナルのわかりやすい名前を取得します。この名前は、ユーザーが利用できるものでなければなりません。

ppName

LPWSTR*

out

ターミナルの名前を格納する BSTR へのポインター。

戻り値

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

値	意味
S_OK	メソッドは成功しました。
E_POINTER	ppName パラメーターが有効なポインターではありません。
E_OUTOFMEMORY	操作を実行するのに十分なメモリがありません。

解説(Remarks)

アプリケーションは、ppName パラメーターに割り当てられたメモリを解放するために SysFreeString を使用する必要があります。

vtbl 8 HRESULT get_State(TERMINAL_STATE* pTerminalState)

get_State メソッドは、ターミナルの現在の状態を取得します。

pTerminalState

TERMINAL_STATE*

out

TERMINAL_STATE 列挙体メンバーへのポインター。

戻り値

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

値	意味
S_OK	メソッドは成功しました。
E_POINTER	pTerminalState パラメーターが有効なポインターではありません。
E_OUTOFMEMORY	操作を実行するのに十分なメモリがありません。

vtbl 9 HRESULT get_TerminalType(TERMINAL_TYPE* pType)

get_TerminalType メソッドは、ターミナルの TERMINAL_TYPE を取得します。

pType

TERMINAL_TYPE*

out

TERMINAL_TYPE へのポインター。

戻り値

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

値	意味
S_OK	メソッドは成功しました。
E_POINTER	pType パラメーターが有効なポインターではありません。
E_OUTOFMEMORY	操作を実行するのに十分なメモリがありません。

vtbl 10 HRESULT get_TerminalClass(LPWSTR* ppTerminalClass)

get_TerminalClass メソッドは、ターミナルの Terminal Class を取得します。

ppTerminalClass

LPWSTR*

out

ターミナルの Terminal Class の BSTR 表現へのポインター。

戻り値

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

値	意味
S_OK	メソッドは成功しました。
E_POINTER	ppTerminalClass パラメーターが有効なポインターではありません。
E_OUTOFMEMORY	操作を実行するのに十分なメモリがありません。

解説(Remarks)

アプリケーションは、ppTerminalClass パラメーターに割り当てられたメモリを解放するために SysFreeString を使用する必要があります。

vtbl 11 HRESULT get_MediaType(INT* plMediaType)

get_MediaType メソッドは、このターミナルがサポートするメディアを判別します。

plMediaType

INT*

out

メディアタイプへのポインター。

戻り値

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

値	意味
S_OK	メソッドは成功しました。
E_POINTER	plMediaType パラメーターが有効なポインターではありません。
E_OUTOFMEMORY	操作を実行するのに十分なメモリがありません。

vtbl 12 HRESULT get_Direction(TERMINAL_DIRECTION* pDirection)

get_Direction メソッドは、ターミナルのメディアストリーム方向を示す TERMINAL_DIRECTION 記述子を取得します。

pDirection

TERMINAL_DIRECTION*

out

ターミナルのメディアストリーム方向を示す TERMINAL_DIRECTION 記述子。

戻り値

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

値	意味
S_OK	メソッドは成功しました。
E_POINTER	pDirection パラメーターが有効なポインターではありません。
E_OUTOFMEMORY	操作を実行するのに十分なメモリがありません。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_ITTerminal "{B1EFC38A-9355-11D0-835C-00AA003CCABD}"
#usecom global ITTerminal IID_ITTerminal "{}"
#comfunc global ITTerminal_get_Name           7 var
#comfunc global ITTerminal_get_State          8 var
#comfunc global ITTerminal_get_TerminalType   9 var
#comfunc global ITTerminal_get_TerminalClass  10 var
#comfunc global ITTerminal_get_MediaType      11 var
#comfunc global ITTerminal_get_Direction      12 var
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。#define global IID_ITTerminal "{B1EFC38A-9355-11D0-835C-00AA003CCABD}"
#usecom global ITTerminal IID_ITTerminal "{}"
#comfunc global ITTerminal_get_Name           7 sptr
#comfunc global ITTerminal_get_State          8 sptr
#comfunc global ITTerminal_get_TerminalType   9 sptr
#comfunc global ITTerminal_get_TerminalClass  10 sptr
#comfunc global ITTerminal_get_MediaType      11 sptr
#comfunc global ITTerminal_get_Direction      12 sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。