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

IWRdsProtocolManager

COM
📘 Microsoft Learn (日本語) · English
IIDdc796967-3abb-40cd-a446-105276b58950継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

リモート デスクトップ サービス サービスがプロトコル プロバイダーと通信するために使用するメソッドを公開します。

解説(Remarks)

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

メソッド 8

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

vtbl 3 HRESULT Initialize(IWRdsProtocolSettings* pIWRdsSettings, WRDS_SETTINGS* pWRdsSettings)

プロトコル マネージャーを初期化します。

pIWRdsSettingsIWRdsProtocolSettings*inIWRdsProtocolSettings インターフェイスを実装するオブジェクトへのポインター。
pWRdsSettingsWRDS_SETTINGS*in使用する設定を格納する WRDS_SETTINGS 構造体へのポインター。

戻り値

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

解説(Remarks)

このメソッドの用途の一例として、インターフェイス オブジェクト ポインターへの参照を追加し、設定構造体のコピーを作成することが考えられます。

vtbl 4 HRESULT CreateListener(LPWSTR wszListenerName, IWRdsProtocolListener** pProtocolListener)

受信するクライアント接続要求をリッスンする IWRdsProtocolListener オブジェクトの作成を要求します。

wszListenerNameLPWSTRin作成するリスナーを指定するレジストリ GUID を格納する文字列へのポインター。
pProtocolListenerIWRdsProtocolListener**outIWRdsProtocolListener オブジェクトへのポインターのアドレス。

戻り値

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

解説(Remarks)

CreateListener メソッドは、リモート デスクトップ サービス サービスがプロトコル プロバイダーに対して最初に行う呼び出しです。このサービスは、作成するリスナーの GUID を見つけるために、レジストリの次のキーを参照します。

HKEY_LOCAL_MACHINE
   System
      CurrentControlSet
         Control
            Terminal Server
               WinStations
                  ListenerName
                     LoadableProtocol_Object
vtbl 5 HRESULT NotifyServiceStateChange(WTS_SERVICE_STATE* pTSServiceStateChange)

リモート デスクトップ サービス サービスの状態が変化していることをプロトコル プロバイダーに通知します。

pTSServiceStateChangeWTS_SERVICE_STATE*inサービスが開始中、停止中、またはドレイン状態を変更中のいずれであるかを指定する WRDS_SERVICE_STATE 構造体へのポインター。

戻り値

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

vtbl 6 HRESULT NotifySessionOfServiceStart(WTS_SESSION_ID* SessionId)

指定されたセッションに対してリモート デスクトップ サービス サービスが開始されたことをプロトコル プロバイダーに通知します。

SessionIdWTS_SESSION_ID*inセッションを一意に識別する WRDS_SESSION_ID 構造体へのポインター。

戻り値

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

vtbl 7 HRESULT NotifySessionOfServiceStop(WTS_SESSION_ID* SessionId)

指定されたセッションに対してリモート デスクトップ サービス サービスが停止したことをプロトコル プロバイダーに通知します。

SessionIdWTS_SESSION_ID*inセッションを一意に識別する WRDS_SESSION_ID 構造体へのポインター。

戻り値

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

vtbl 8 HRESULT NotifySessionStateChange(WTS_SESSION_ID* SessionId, DWORD EventId)

セッションの状態の変化をプロトコル プロバイダーに通知します。

SessionIdWTS_SESSION_ID*inセッションを一意に識別する WRDS_SESSION_ID 構造体へのポインター。
EventIdDWORDin

イベント ID を格納する整数。次の ID は Winuser.h で確認できます。

WTS_CONSOLE_CONNECT (0x1)

WTS_CONSOLE_DISCONNECT (0x2)

WTS_REMOTE_CONNECT (0x3)

WTS_SESSION_LOGOFF (0x6)

WTS_SESSION_LOCK (0x7)

WTS_SESSION_UNLOCK (0x8)

WTS_SESSION_REMOTE_CONTROL (0x9)

戻り値

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

vtbl 9 HRESULT NotifySettingsChange(WRDS_SETTINGS* pWRdsSettings)

リモート デスクトップ サービス サービス内の設定の変更をプロトコル プロバイダーに通知します。

pWRdsSettingsWRDS_SETTINGS*in設定の変更内容を格納する WRDS_SETTINGS 構造体へのポインター。

戻り値

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

vtbl 10 HRESULT Uninitialize()

プロトコル マネージャーの初期化を解除します。

戻り値

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

解説(Remarks)

このメソッドは、Initialize メソッドで使用したリソースをクリーンアップするために実装できます。たとえば、Initialize メソッドが IWRdsProtocolSettings オブジェクト ポインターへの参照を追加していた場合、Uninitialize メソッドでその参照を解放できます。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IWRdsProtocolManager "{DC796967-3ABB-40CD-A446-105276B58950}"
#usecom global IWRdsProtocolManager IID_IWRdsProtocolManager "{}"
#comfunc global IWRdsProtocolManager_Initialize                   3 sptr,var
#comfunc global IWRdsProtocolManager_CreateListener               4 wstr,sptr
#comfunc global IWRdsProtocolManager_NotifyServiceStateChange     5 var
#comfunc global IWRdsProtocolManager_NotifySessionOfServiceStart  6 var
#comfunc global IWRdsProtocolManager_NotifySessionOfServiceStop   7 var
#comfunc global IWRdsProtocolManager_NotifySessionStateChange     8 var,int
#comfunc global IWRdsProtocolManager_NotifySettingsChange         9 var
#comfunc global IWRdsProtocolManager_Uninitialize                 10
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。