ホーム › Devices.Tapi › ITMSPAddress

ITMSPAddress

COM

📘 Microsoft Learn (日本語) · English

IIDee3bd600-3868-11d2-a045-00c04fb6809f継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

ITMSPAddress (msp.h) インターフェースは MSP によって実装され、TAPI DLL に対するメディアサービスプロバイダーを表します。

メソッド 6

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

vtbl 3 HRESULT Initialize(INT* hEvent)

ITMSPAddress::Initialize (msp.h) メソッドは、MSP がロードされるときに呼び出されます。

hEvent

INT*

この MSP に対する TAPI 3 のハンドルです。

戻り値

このメソッドは次のいずれかの値を返します。

値	意味
S_OK	メソッドが成功しました。
E_OUTOFMEMORY	操作を実行するのに十分なメモリがありません。

解説(Remarks)

MSP が MSP 基底クラスを使用して記述されている場合、このメソッドはデータメンバーを初期化し、Terminal Manager を作成し、グローバル MSP スレッドオブジェクトに対して Start を呼び出します。

vtbl 4 HRESULT Shutdown()

ITMSPAddress::Shutdown (msp.h) メソッドは、MSP がアンロードされるときに呼び出されます。Shutdown はアドレスオブジェクトごとに 1 回呼び出されます。

戻り値

このメソッドは次のいずれかの値を返します。

値	意味
S_OK	メソッドが成功しました。
E_NOTIMPL	メソッドは実装されていません。

解説(Remarks)

このメソッドはターミナルを解放し、Terminal Manager を解放します。未処理のイベントをすべて解放し、グローバル MSP スレッドオブジェクトに対して Stop を呼び出します。この関数が呼び出されるとき、アクティブな通話は存在しないはずです。ただし、アプリケーションのバグにより通話やターミナルが残ってしまう場合があります。

vtbl 5 HRESULT CreateMSPCall(INT* hCall, DWORD dwReserved, DWORD dwMediaType, IUnknown* pOuterUnknown, IUnknown** ppStreamControl)

ITMSPAddress::CreateMSPCall (msp.h) メソッドは、MSP Call オブジェクトを作成します。

hCall	INT*	in	この MSP に対するハンドルです。
dwReserved	DWORD	in	予約された値です。0 になります。
dwMediaType	DWORD	in	通話に必要なメディアタイプを示します。
pOuterUnknown	IUnknown*	inoptional	TAPI 3 call オブジェクト上の IUnknown インターフェースへのポインターです。MSP Call オブジェクトは TAPI 3 call オブジェクトに集約(アグリゲート)されるため、外側の IUnknown を知る必要があります。
ppStreamControl	IUnknown**	out	新しく作成された通話に対する ITStreamControl インターフェースの IUnknown インターフェースポインターへのポインターです。

戻り値

このメソッドは次のいずれかの値を返します。

値	意味
S_OK	メソッドが成功しました。
E_FAIL	MSP の初期化に失敗しました。
E_POINTER	pMSPCallback が有効なポインターではありません。
E_OUTOFMEMORY	操作を実行するのに十分なメモリがありません。
TAPI_E_INVALIDMEDIATYPE	dwMediaType が有効なメディアタイプではありません。

vtbl 6 HRESULT ShutdownMSPCall(IUnknown* pStreamControl)

ITMSPAddress::ShutdownMSPCall (msp.h) メソッドは、call オブジェクトが破棄されるときに呼び出されます。

pStreamControl

IUnknown*

inoptional

通話の ITStreamControl の IUnknown インターフェースへのポインターです。

戻り値

このメソッドは次のいずれかの値を返します。

値	意味
S_OK	メソッドが成功しました。
E_POINTER	pStreamControl パラメーターが有効なポインターではありません。
E_INVALIDARG	pStreamControl パラメーターが有効な ITStreamControl インターフェースを指していません。

解説(Remarks)

このメソッドは、通話が切断状態になったときに自動的に呼び出されるわけではありません。MSP と対になる TSP はこの通話状態の変化を MSP に通知する必要がありますが、アプリケーションは切断後も情報ログ記録の目的で call オブジェクトを保持している場合があるため、call オブジェクト自体が解放されるまで shutdown を呼び出すべきではありません。

vtbl 7 HRESULT ReceiveTSPData(IUnknown* pMSPCall, BYTE* pBuffer, DWORD dwSize)

ITMSPAddress::ReceiveTSPData (msp.h) メソッドは、TSP が非同期データを MSP に送信するときに TAPI 3 によって呼び出されます。

pMSPCall	IUnknown*	inoptional	MSP Call オブジェクトの IUnknown インターフェースへのポインターです。
pBuffer	BYTE*	in	[in, size_is(dwSize)] TSP からの不透明なバッファーへのポインターです。
dwSize	DWORD	in	pBuffer のサイズ(バイト単位)です。

戻り値

このメソッドは次のいずれかの値を返します。

値	意味
S_OK	メソッドが成功しました。
E_POINTER	pMSPCall または pBuffer パラメーターが有効なポインターではありません。
E_INVALIDARG	pMSPCall パラメーターが NULL です。
E_FAIL	pMSPCall パラメーターが有効なインターフェースを指していません。
E_OUTOFMEMORY	操作を実行するのに十分なメモリがありません。

解説(Remarks)

MSP は pBuffer 内のメモリを解放する必要があります。

バッファーで渡されるデータのセマンティクスは、TSP/MSP のペアごとに固有です。このメソッドは、受信したバッファーをアドレス(pMSPCall == NULL)または指定された通話(pMSPCall != NULL)に単にディスパッチします。

vtbl 8 HRESULT GetEvent(DWORD* pdwSize, BYTE* pEventBuffer)

ITMSPAddress::GetEvent (msp.h) メソッドは、イベント情報を取得します。

pdwSize	DWORD*	inout	pEventBuffer のサイズ(バイト単位)を格納する DWORD へのポインターです。成功すると、pdwSize は pEventBuffer 内の実際のバイト数を返します。pEventBuffer が十分な大きさでない場合、このメソッドは TAPI_E_NOTENOUGHMEMORY を返し、このパラメーターは必要なバイト数を返します。
pEventBuffer	BYTE*	inout	[in, out, size_is(*pdwSize)] MSP event_info 情報を格納するバッファーへのポインターです。

戻り値

このメソッドは次のいずれかの値を返します。

値	意味
S_OK	メソッドが成功しました。
E_NOTIMPL	メソッドは実装されていません。
E_POINTER	pdwSize または pEventBuffer パラメーターが有効なポインターではありません。
E_OUTOFMEMORY	操作を実行するのに十分なメモリがありません。
TAPI_E_NOTENOUGHMEMORY	pdwSize パラメーターがバッファーに対して十分な大きさではありませんでした。
TAPI_E_NOEVENT	イベントが発生していません。

解説(Remarks)

TAPI3 は、initialize で指定されたイベントハンドルがシグナル状態になると、このメソッドを呼び出します。TAPI は複数のイベントを取得できるように、失敗するまでこのメソッドを繰り返し呼び出します。各呼び出しでは、1 つのイベント構造体のみを返す必要があります。

MSP 基底クラスの利用者向け: このメソッドはイベントリストをロックします。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_ITMSPAddress "{EE3BD600-3868-11D2-A045-00C04FB6809F}"
#usecom global ITMSPAddress IID_ITMSPAddress "{}"
#comfunc global ITMSPAddress_Initialize       3 var
#comfunc global ITMSPAddress_Shutdown         4
#comfunc global ITMSPAddress_CreateMSPCall    5 var,int,int,sptr,sptr
#comfunc global ITMSPAddress_ShutdownMSPCall  6 sptr
#comfunc global ITMSPAddress_ReceiveTSPData   7 sptr,var,int
#comfunc global ITMSPAddress_GetEvent         8 var,var
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。#define global IID_ITMSPAddress "{EE3BD600-3868-11D2-A045-00C04FB6809F}"
#usecom global ITMSPAddress IID_ITMSPAddress "{}"
#comfunc global ITMSPAddress_Initialize       3 sptr
#comfunc global ITMSPAddress_Shutdown         4
#comfunc global ITMSPAddress_CreateMSPCall    5 sptr,int,int,sptr,sptr
#comfunc global ITMSPAddress_ShutdownMSPCall  6 sptr
#comfunc global ITMSPAddress_ReceiveTSPData   7 sptr,sptr,int
#comfunc global ITMSPAddress_GetEvent         8 sptr,sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。