IWTSProtocolConnection
COM公式ドキュメント
IWTSProtocolConnection は利用できなくなりました。代わりに IWRdsProtocolConnection を使用してください。
メソッド 23
vtbl = vtable インデックス(0始まり)。HSP等からCOMメソッドをインデックス指定で呼ぶ際に使用します。0〜2 は IUnknown。
IWTSProtocolConnection::GetLogonErrorRedirector は利用できなくなりました。代わりに IWRdsProtocolConnection::GetLogonErrorRedirector を使用してください。
| ppLogonErrorRedir | IWTSProtocolLogonErrorRedirector** | out | IWTSProtocolLogonErrorRedirector インターフェイスへのポインターのアドレスです。 |
解説(Remarks)
IWTSProtocolLogonErrorRedirector インターフェイスは、リモートデスクトップサービスからステータスおよびエラーメッセージを受け取るためにプロトコルによって実装されます。
IWTSProtocolConnection::SendPolicyData は利用できなくなりました。代わりに IWRdsProtocolManager::NotifySettingsChange を使用してください。
| pPolicyData | WTS_POLICY_DATA* | in | コンピューターのポリシー設定を格納する WTS_POLICY_DATA 構造体へのポインターです。 |
解説(Remarks)
SendPolicyData メソッドは、接続シーケンス中にリモートデスクトップサービスによって 2 番目に呼び出されるメソッドです。プロトコルは、このメソッドが呼び出された後に OnReady メソッドを呼び出す必要があります。呼び出さない場合、接続は切断されます。
IWTSProtocolConnection::AcceptConnection は利用できなくなりました。代わりに IWRdsProtocolConnection::AcceptConnection を使用してください。
解説(Remarks)
接続シーケンス中、リモートデスクトップサービスは、クライアントから接続要求を受け取り、SendPolicyData メソッドを呼び出した後に、このメソッドを呼び出します。
IWTSProtocolConnection::GetClientData は利用できなくなりました。代わりに IWRdsProtocolConnection::GetClientData を使用してください。
| pClientData | WTS_CLIENT_DATA* | out | クライアント設定を格納する WTS_CLIENT_DATA 構造体へのポインターです。 |
IWTSProtocolConnection::GetUserCredentials は利用できなくなりました。代わりに IWRdsProtocolConnection::GetUserCredentials を使用してください。
| pUserCreds | WTS_USER_CREDENTIAL* | out | 資格情報を格納する WTS_USER_CREDENTIAL 構造体へのポインターです。現在サポートされているのは、ユーザー名、パスワード、およびドメインのみです。ユーザー名とパスワードはプレーンテキストです。 |
戻り値
このメソッドを実装する場合、関数が成功したときは S_OK を返します。失敗したときは、エラーを示す HRESULT 値を返します。一般的なエラーコードの一覧については、Common HRESULT Values を参照してください。
解説(Remarks)
プロトコルが HRESULT エラーコードを返した場合、またはユーザーが誤った資格情報を提供した場合、WinLogon は資格情報を要求するためにログオン画面を表示します。プロトコルが S_OK を返した場合、資格情報はユーザーをログオンさせるために WinLogon に渡されます。
IWTSProtocolConnection::GetLicenseConnection は利用できなくなりました。代わりに IWRdsProtocolConnection::GetLicenseConnection を使用してください。
| ppLicenseConnection | IWTSProtocolLicenseConnection** | out | IWTSProtocolLicenseConnection インターフェイスへのポインターのアドレスです。 |
IWTSProtocolConnection::AuthenticateClientToSession は利用できなくなりました。代わりに IWRdsProtocolConnection::AuthenticateClientToSession を使用してください。
| SessionId | WTS_SESSION_ID* | out | セッションを一意に識別する WTS_SESSION_ID 構造体へのポインターです。 |
IWTSProtocolConnection::NotifySessionId は利用できなくなりました。代わりに IWRdsProtocolConnection::NotifySessionId を使用してください。
| SessionId | WTS_SESSION_ID* | in | 接続 GUID および関連するセッション ID を格納する WTS_SESSION_ID 構造体へのポインターです。 |
解説(Remarks)
これはイベント通知であり、このメソッドからは直ちに戻る必要があります。デッドロックの可能性を避けるため、直接的または間接的にリモートデスクトップサービス API の呼び出しにつながる関数呼び出しやメソッド呼び出しを行わないでください。外部への呼び出しを行う必要がある場合は、新しいスレッドを開始し、その新しいスレッドから外部への呼び出しを行ってください。
IWTSProtocolConnection::GetProtocolHandles は利用できなくなりました。
| pKeyboardHandle | HANDLE_PTR* | out | キーボードハンドルへのポインターです。これは I8042prt キーボードドライバー へのハンドルです。 |
| pMouseHandle | HANDLE_PTR* | out | マウスハンドルへのポインターです。これは Mouclass ドライバー へのハンドルです。 |
| pBeepHandle | HANDLE_PTR* | out | ビープデバイスハンドルへのポインターです。このハンドルは使用されず、NULL に設定する必要があります。 |
| pVideoHandle | HANDLE_PTR* | out | ビデオデバイスハンドルへのポインターです。これは、プロトコルに関連付けられたリモートセッションのビデオミニポートドライバーへのハンドルです。 |
IWTSProtocolConnection::ConnectNotify は利用できなくなりました。代わりに IWRdsProtocolConnection::ConnectNotify を使用してください。
| SessionId | DWORD | in | クライアントに関連付けられたセッション ID を格納する整数です。 |
解説(Remarks)
これはイベント通知であり、このメソッドからは直ちに戻る必要があります。デッドロックの可能性を避けるため、直接的または間接的にリモートデスクトップサービス API の呼び出しにつながる関数呼び出しやメソッド呼び出しを行わないでください。外部への呼び出しを行う必要がある場合は、新しいスレッドを開始し、その新しいスレッドから外部への呼び出しを行ってください。
IWTSProtocolConnection::IsUserAllowedToLogon は利用できなくなりました。代わりに IWRdsProtocolConnection::IsUserAllowedToLogon を使用してください。
| SessionId | DWORD | in | ユーザーに関連付けられたセッション ID を格納する整数です。 |
| UserToken | HANDLE_PTR | in | ユーザートークンハンドルへのポインターです。 |
| pDomainName | LPWSTR | in | ユーザーのドメイン名を格納する文字列へのポインターです。 |
| pUserName | LPWSTR | in | ユーザー名を格納する文字列へのポインターです。 |
IWTSProtocolConnection::SessionArbitrationEnumeration は利用できなくなりました。代わりに IWRdsProtocolConnection::SessionArbitrationEnumeration を使用してください。
| hUserToken | HANDLE_PTR | in | ユーザートークンハンドルへのポインターです。 |
| bSingleSessionPerUserEnabled | BOOL | in | ユーザーを最大 1 つのセッションにのみ関連付けられるかどうかを指定するブール値です。 |
| pSessionIdArray | DWORD* | out | ユーザーの切断済みセッション ID を格納する整数の配列へのポインターです。 |
| pdwSessionIdentifierCount | DWORD* | inout | pSessionIdArray パラメーターによって参照される切断済みセッション ID の数を指定する整数へのポインターです。 |
解説(Remarks)
リモートデスクトップサービスは、このユーザーが再接続できる既存のセッションを見つけるためにこのメソッドを呼び出します。このメソッドが HRESULT エラーコードを返す場合、またはセッション ID を 1 つも返さない場合、リモートデスクトップサービスは自身で調停を実行します。
IWTSProtocolConnection::LogonNotify は利用できなくなりました。代わりに IWRdsProtocolConnection::LogonNotify を使用してください。
| hClientToken | HANDLE_PTR | in | ユーザートークンハンドルへのポインターです。 |
| wszUserName | LPWSTR | in | ユーザー名を格納する文字列へのポインターです。 |
| wszDomainName | LPWSTR | in | ユーザーのドメイン名を格納する文字列へのポインターです。 |
| SessionId | WTS_SESSION_ID* | in | ユーザーに関連付けられたセッション ID を格納する WTS_SESSION_ID 構造体へのポインターです。 |
解説(Remarks)
リモートデスクトップサービスは、セッションの状態が変化したときにもこのメソッドを呼び出します。
これはイベント通知であり、このメソッドからは直ちに戻る必要があります。デッドロックの可能性を避けるため、直接的または間接的に リモートデスクトップサービス API の呼び出しにつながる関数呼び出しやメソッド呼び出しを行わないでください。外部への呼び出しを行う必要がある場合は、新しいスレッドを開始し、その新しいスレッドから外部への呼び出しを行ってください。
IWTSProtocolConnection::GetUserData は利用できなくなりました。代わりに IWRdsProtocolSettings::MergeSettings を使用してください。
| pPolicyData | WTS_POLICY_DATA* | in | マージされたグループポリシー値を格納する WTS_POLICY_DATA 構造体へのポインターです。 |
| pClientData | WTS_USER_DATA* | inout | クライアントのプロパティ情報を格納する WTS_USER_DATA 構造体へのポインターです。 |
解説(Remarks)
リモートデスクトップサービスは、このメソッドを呼び出す前に、リスナー設定、クライアントから提供されたデータ、グループポリシーデータを含むすべてのポリシーデータをマージします。
IWTSProtocolConnection::DisconnectNotify は利用できなくなりました。代わりに IWRdsProtocolConnection::DisconnectNotify を使用してください。
解説(Remarks)
これはイベント通知であり、このメソッドからは直ちに戻る必要があります。デッドロックの可能性を避けるため、直接的または間接的にリモートデスクトップサービス API の呼び出しにつながる関数呼び出しやメソッド呼び出しを行わないでください。外部への呼び出しを行う必要がある場合は、新しいスレッドを開始し、その新しいスレッドから外部への呼び出しを行ってください。
IWTSProtocolConnection::Close は利用できなくなりました。代わりに IWRdsProtocolConnection::Close を使用してください。
解説(Remarks)
プロトコルは、接続を閉じて IWTSProtocolConnectionCallback オブジェクトを削除するために必要なクリーンアップを実行する必要があります。
IWTSProtocolConnection::GetProtocolStatus は利用できなくなりました。代わりに IWRdsProtocolConnection::GetProtocolStatus を使用してください。
| pProtocolStatus | WTS_PROTOCOL_STATUS* | out | プロトコルのカウンター、シグナル、キャッシュ情報を格納する WTS_PROTOCOL_STATUS 構造体へのポインターです。 |
IWTSProtocolConnection::GetLastInputTime は利用できなくなりました。代わりに IWRdsProtocolConnection::GetLastInputTime を使用してください。
| pLastInputTime | ULONGLONG* | out | 経過時間をミリ秒単位で格納する整数です。 |
IWTSProtocolConnection::SetErrorInfo は利用できなくなりました。代わりに IWRdsProtocolConnection::SetErrorInfo を使用してください。
| ulError | DWORD | in | エラーコードを格納する整数です。 |
IWTSProtocolConnection::SendBeep は利用できなくなりました。
| Frequency | DWORD | in | 37 から 32,767 ヘルツの範囲のパルス周波数を格納する整数です。 |
| Duration | DWORD | in | パルスの持続時間をミリ秒単位で格納する整数です。 |
IWTSProtocolConnection::CreateVirtualChannel は利用できなくなりました。代わりに IWRdsProtocolConnection::CreateVirtualChannel を使用してください。
| szEndpointName | LPSTR | in | 接続を一意に識別するエンドポイントデータを格納する文字列値です。 |
| bStatic | BOOL | in | 仮想チャネルが静的か動的かを指定するブール値です。TRUE の値は静的チャネルを指定します。 |
| RequestedPriority | DWORD | in | 優先度を格納する整数です。 |
| phChannel | UINT_PTR* | out | チャネルハンドルへのポインターです。 |
解説(Remarks)
仮想チャネルは、リモートデスクトップサービスアプリケーションを拡張するために作成できるソフトウェア拡張機能です。例としては、追加のハードウェアのサポートや、特定のプロトコルによって提供される機能への追加などがあります。詳細については、リモートデスクトップサービスの仮想チャネル を参照してください。
IWTSProtocolConnection::QueryProperty は利用できなくなりました。代わりに IWRdsProtocolConnection::QueryProperty を使用してください。
| QueryType | GUID | in | プロパティを指定する GUID です。次のいずれかの値を指定できます。 WTS_QUERY_ALLOWED_INITIAL_APP (C77D1B30-5BE1-4c6b-A0E1-BD6D2E5C9FCC)リモートデスクトップサービスによって送信され、初期アプリケーションの実行を許可するかどうかを判断します。 入力時、リモートデスクトップサービスは pPropertyEntriesIn パラメーターで 3 つの WTS_PROPERTY_VALUE 構造体を渡します。 入力構造体 1:
出力構造体 1:
WTS_QUERY_LOGON_SCREEN_SIZE (8b8e0fe7-0804-4a0e-b279-8660b1df0049)WinLogon がログオン画面のサイズを判断するために使用します。 pPropertyEntriesIn パラメーターは NULL になります。 pPropertyEntriesOut パラメーターを次のように設定します。
WTS_QUERY_AUDIOENUM_DLL (9bf4fa97-c883-4c2a-80ab-5a39c9af00db)リモートデスクトップサービスが、リモートオーディオ列挙子 DLL の名前を照会するために使用します。 pPropertyEntriesIn パラメーターは NULL になります。 pPropertyEntriesOut パラメーターを次のように設定します。
WTS_QUERY_MF_FORMAT_SUPPORT (41869ad0-6332-4dc8-95d5-db749e2f1d94)リモートデスクトップ Media Foundation プラグインが、特定のメディア形式に使用するシンクオブジェクトを判断するために使用します。 入力時、RCM は pPropertyEntriesIn パラメーターで次の WTS_PROPERTY_VALUE 構造体を渡します。
PROPERTY_DYNAMIC_TIME_ZONE_INFORMATION (cdfd28e-d0b9-4c1f-a5eb-6d1f6c6535b9)接続から動的なタイムゾーン情報を取得するために使用します。 pPropertyEntriesIn パラメーターは NULL になります。 出力時、pPropertyEntriesOut パラメーターで次の WRDS_PROPERTY_VALUE 構造体を渡します。
|
| ulNumEntriesIn | DWORD | in | pPropertyEntriesIn 引数で渡される WTS_PROPERTY_VALUE 構造体の数を格納する整数です。 |
| ulNumEntriesOut | DWORD | in | pPropertyEntriesOut 引数で渡される WTS_PROPERTY_VALUE 構造体の数を格納する整数です。 |
| pPropertyEntriesIn | WTS_PROPERTY_VALUE* | in | 要求されたプロパティ情報を見つけるのに役立てられる 1 つ以上の WTS_PROPERTY_VALUE 構造体です。 |
| pPropertyEntriesOut | WTS_PROPERTY_VALUE* | out | 要求されたプロパティ情報を格納する 1 つ以上の WTS_PROPERTY_VALUE 構造体です。 |
IWTSProtocolConnection::GetShadowConnection は利用できなくなりました。代わりに IWRdsProtocolConnection::GetShadowConnection を使用してください。
| ppShadowConnection | IWTSProtocolShadowConnection** | out | IWTSProtocolShadowConnection インターフェイスへのポインターのアドレスです。 |
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
HSP用 COM定義
#usecom / #comfunc によるHSPのCOM呼び出し定義。数字は vtbl インデックス(0始まり)。クラスIDが無い場合 #usecom の末尾は "{}"、ある場合は "{CLSID}"。
#define global IID_IWTSProtocolConnection "{23083765-9095-4648-98BF-EF81C914032D}" #usecom global IWTSProtocolConnection IID_IWTSProtocolConnection "{}" #comfunc global IWTSProtocolConnection_GetLogonErrorRedirector 3 sptr #comfunc global IWTSProtocolConnection_SendPolicyData 4 var #comfunc global IWTSProtocolConnection_AcceptConnection 5 #comfunc global IWTSProtocolConnection_GetClientData 6 var #comfunc global IWTSProtocolConnection_GetUserCredentials 7 var #comfunc global IWTSProtocolConnection_GetLicenseConnection 8 sptr #comfunc global IWTSProtocolConnection_AuthenticateClientToSession 9 var #comfunc global IWTSProtocolConnection_NotifySessionId 10 var #comfunc global IWTSProtocolConnection_GetProtocolHandles 11 var,var,var,var #comfunc global IWTSProtocolConnection_ConnectNotify 12 int #comfunc global IWTSProtocolConnection_IsUserAllowedToLogon 13 int,sptr,wstr,wstr #comfunc global IWTSProtocolConnection_SessionArbitrationEnumeration 14 sptr,int,var,var #comfunc global IWTSProtocolConnection_LogonNotify 15 sptr,wstr,wstr,var #comfunc global IWTSProtocolConnection_GetUserData 16 var,var #comfunc global IWTSProtocolConnection_DisconnectNotify 17 #comfunc global IWTSProtocolConnection_Close 18 #comfunc global IWTSProtocolConnection_GetProtocolStatus 19 var #comfunc global IWTSProtocolConnection_GetLastInputTime 20 var #comfunc global IWTSProtocolConnection_SetErrorInfo 21 int #comfunc global IWTSProtocolConnection_SendBeep 22 int,int #comfunc global IWTSProtocolConnection_CreateVirtualChannel 23 str,int,int,var #comfunc global IWTSProtocolConnection_QueryProperty 24 int,int,int,var,var #comfunc global IWTSProtocolConnection_GetShadowConnection 25 sptr ; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。 ; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。 ; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。 ; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。#define global IID_IWTSProtocolConnection "{23083765-9095-4648-98BF-EF81C914032D}" #usecom global IWTSProtocolConnection IID_IWTSProtocolConnection "{}" #comfunc global IWTSProtocolConnection_GetLogonErrorRedirector 3 sptr #comfunc global IWTSProtocolConnection_SendPolicyData 4 sptr #comfunc global IWTSProtocolConnection_AcceptConnection 5 #comfunc global IWTSProtocolConnection_GetClientData 6 sptr #comfunc global IWTSProtocolConnection_GetUserCredentials 7 sptr #comfunc global IWTSProtocolConnection_GetLicenseConnection 8 sptr #comfunc global IWTSProtocolConnection_AuthenticateClientToSession 9 sptr #comfunc global IWTSProtocolConnection_NotifySessionId 10 sptr #comfunc global IWTSProtocolConnection_GetProtocolHandles 11 sptr,sptr,sptr,sptr #comfunc global IWTSProtocolConnection_ConnectNotify 12 int #comfunc global IWTSProtocolConnection_IsUserAllowedToLogon 13 int,sptr,wstr,wstr #comfunc global IWTSProtocolConnection_SessionArbitrationEnumeration 14 sptr,int,sptr,sptr #comfunc global IWTSProtocolConnection_LogonNotify 15 sptr,wstr,wstr,sptr #comfunc global IWTSProtocolConnection_GetUserData 16 sptr,sptr #comfunc global IWTSProtocolConnection_DisconnectNotify 17 #comfunc global IWTSProtocolConnection_Close 18 #comfunc global IWTSProtocolConnection_GetProtocolStatus 19 sptr #comfunc global IWTSProtocolConnection_GetLastInputTime 20 sptr #comfunc global IWTSProtocolConnection_SetErrorInfo 21 int #comfunc global IWTSProtocolConnection_SendBeep 22 int,int #comfunc global IWTSProtocolConnection_CreateVirtualChannel 23 str,int,int,sptr #comfunc global IWTSProtocolConnection_QueryProperty 24 int,int,int,sptr,sptr #comfunc global IWTSProtocolConnection_GetShadowConnection 25 sptr ; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。 ; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。 ; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。 ; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。