Win32 API 日本語リファレンス
ホームSystem.RemoteDesktop › IWRdsProtocolListener

IWRdsProtocolListener

COM
IIDfcbc131b-c686-451d-a773-e279e230f540継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

プロトコルに対してクライアント接続要求のリッスンの開始および停止を要求するメソッドを公開します。

解説(Remarks)

このインターフェイスのいずれかのメソッドを呼び出す際にデッドロックが発生する可能性を避けるため、直接的または間接的にリモートデスクトップサービスAPIの呼び出しを引き起こすような関数呼び出しやメソッド呼び出しを行わないでください。外部への呼び出しを行う必要がある場合は、新しいスレッドを起動し、その新しいスレッドから外部への呼び出しを行ってください。

メソッド 3

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

vtbl 3 HRESULT GetSettings(WRDS_LISTENER_SETTING_LEVEL WRdsListenerSettingLevel, WRDS_LISTENER_SETTINGS* pWRdsListenerSettings)

クライアント接続要求に関するリスナーの設定情報を取得します。

WRdsListenerSettingLevelWRDS_LISTENER_SETTING_LEVELin使用するリスナー設定レベル。
pWRdsListenerSettingsWRDS_LISTENER_SETTINGS*out返されるリスナー設定が格納される WRDS_LISTENER_SETTINGS 構造体へのポインター。

戻り値

このメソッドを実装する際は、関数が成功した場合は S_OK を返してください。失敗した場合は、 エラーを示す HRESULT 値を返してください。一般的なエラーコードの一覧については、 Common HRESULT Values を参照してください。

vtbl 4 HRESULT StartListen(IWRdsProtocolListenerCallback* pCallback)

クライアント接続要求のリッスンを開始するようプロトコルに通知します。

pCallbackIWRdsProtocolListenerCallback*in

リモートデスクトップサービスのサービスによって実装された IWRdsProtocolListenerCallback オブジェクトへのポインター。 プロトコルは、着信接続要求について

リモートデスクトップサービス のサービスに通知するために IWRdsProtocolListenerCallback オブジェクトを使用します。プロトコルはこのオブジェクトへの参照を追加し、 StopListen が呼び出されたときに解放する必要があります。

戻り値

このメソッドを実装する際は、関数が成功した場合は S_OK を返してください。失敗した場合は、 エラーを示す HRESULT 値を返してください。一般的なエラーコードの一覧については、 Common HRESULT Values を参照してください。

解説(Remarks)

StartListen メソッドは、リモートデスクトップサービスのサービスが起動するときに呼び出されます。

  1. リモートデスクトップサービスのサービスは、CoCreateInstance を呼び出して IWRdsProtocolManager オブジェクトを作成します。
  2. リモートデスクトップサービスのサービスは、IWRdsProtocolManager インターフェイス上の CreateListener を呼び出します。プロトコルは IWRdsProtocolListener オブジェクトを作成し、それをリモートデスクトップサービスのサービスに返します。
  3. リモートデスクトップサービスのサービスは、IWRdsProtocolListener オブジェクト上の StartListen を呼び出します。
vtbl 5 HRESULT StopListen()

クライアント接続要求のリッスンを停止するようプロトコルに通知します。

戻り値

このメソッドを実装する際は、関数が成功した場合は S_OK を返してください。失敗した場合は、エラーを示す HRESULT 値を返してください。一般的なエラーコードの一覧については、Common HRESULT Values を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IWRdsProtocolListener "{FCBC131B-C686-451D-A773-E279E230F540}"
#usecom global IWRdsProtocolListener IID_IWRdsProtocolListener "{}"
#comfunc global IWRdsProtocolListener_GetSettings  3 int,var
#comfunc global IWRdsProtocolListener_StartListen  4 sptr
#comfunc global IWRdsProtocolListener_StopListen   5
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。