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

IWTSProtocolConnection

COM
IID23083765-9095-4648-98bf-ef81c914032d継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

IWTSProtocolConnection は利用できなくなりました。代わりに IWRdsProtocolConnection を使用してください。

メソッド 23

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

vtbl 3 HRESULT GetLogonErrorRedirector(IWTSProtocolLogonErrorRedirector** ppLogonErrorRedir)

IWTSProtocolConnection::GetLogonErrorRedirector は利用できなくなりました。代わりに IWRdsProtocolConnection::GetLogonErrorRedirector を使用してください。

ppLogonErrorRedirIWTSProtocolLogonErrorRedirector**outIWTSProtocolLogonErrorRedirector インターフェイスへのポインターのアドレスです。

解説(Remarks)

IWTSProtocolLogonErrorRedirector インターフェイスは、リモートデスクトップサービスからステータスおよびエラーメッセージを受け取るためにプロトコルによって実装されます。

vtbl 4 HRESULT SendPolicyData(WTS_POLICY_DATA* pPolicyData)

IWTSProtocolConnection::SendPolicyData は利用できなくなりました。代わりに IWRdsProtocolManager::NotifySettingsChange を使用してください。

pPolicyDataWTS_POLICY_DATA*inコンピューターのポリシー設定を格納する WTS_POLICY_DATA 構造体へのポインターです。

解説(Remarks)

SendPolicyData メソッドは、接続シーケンス中にリモートデスクトップサービスによって 2 番目に呼び出されるメソッドです。プロトコルは、このメソッドが呼び出された後に OnReady メソッドを呼び出す必要があります。呼び出さない場合、接続は切断されます。

vtbl 5 HRESULT AcceptConnection()

IWTSProtocolConnection::AcceptConnection は利用できなくなりました。代わりに IWRdsProtocolConnection::AcceptConnection を使用してください。

解説(Remarks)

接続シーケンス中、リモートデスクトップサービスは、クライアントから接続要求を受け取り、SendPolicyData メソッドを呼び出した後に、このメソッドを呼び出します。

vtbl 6 HRESULT GetClientData(WTS_CLIENT_DATA* pClientData)

IWTSProtocolConnection::GetClientData は利用できなくなりました。代わりに IWRdsProtocolConnection::GetClientData を使用してください。

pClientDataWTS_CLIENT_DATA*outクライアント設定を格納する WTS_CLIENT_DATA 構造体へのポインターです。
vtbl 7 HRESULT GetUserCredentials(WTS_USER_CREDENTIAL* pUserCreds)

IWTSProtocolConnection::GetUserCredentials は利用できなくなりました。代わりに IWRdsProtocolConnection::GetUserCredentials を使用してください。

pUserCredsWTS_USER_CREDENTIAL*out資格情報を格納する WTS_USER_CREDENTIAL 構造体へのポインターです。現在サポートされているのは、ユーザー名、パスワード、およびドメインのみです。ユーザー名とパスワードはプレーンテキストです。

戻り値

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

解説(Remarks)

プロトコルが HRESULT エラーコードを返した場合、またはユーザーが誤った資格情報を提供した場合、WinLogon は資格情報を要求するためにログオン画面を表示します。プロトコルが S_OK を返した場合、資格情報はユーザーをログオンさせるために WinLogon に渡されます。

vtbl 8 HRESULT GetLicenseConnection(IWTSProtocolLicenseConnection** ppLicenseConnection)

IWTSProtocolConnection::GetLicenseConnection は利用できなくなりました。代わりに IWRdsProtocolConnection::GetLicenseConnection を使用してください。

ppLicenseConnectionIWTSProtocolLicenseConnection**outIWTSProtocolLicenseConnection インターフェイスへのポインターのアドレスです。
vtbl 9 HRESULT AuthenticateClientToSession(WTS_SESSION_ID* SessionId)

IWTSProtocolConnection::AuthenticateClientToSession は利用できなくなりました。代わりに IWRdsProtocolConnection::AuthenticateClientToSession を使用してください。

SessionIdWTS_SESSION_ID*outセッションを一意に識別する WTS_SESSION_ID 構造体へのポインターです。
vtbl 10 HRESULT NotifySessionId(WTS_SESSION_ID* SessionId)

IWTSProtocolConnection::NotifySessionId は利用できなくなりました。代わりに IWRdsProtocolConnection::NotifySessionId を使用してください。

SessionIdWTS_SESSION_ID*in接続 GUID および関連するセッション ID を格納する WTS_SESSION_ID 構造体へのポインターです。

解説(Remarks)

これはイベント通知であり、このメソッドからは直ちに戻る必要があります。デッドロックの可能性を避けるため、直接的または間接的にリモートデスクトップサービス API の呼び出しにつながる関数呼び出しやメソッド呼び出しを行わないでください。外部への呼び出しを行う必要がある場合は、新しいスレッドを開始し、その新しいスレッドから外部への呼び出しを行ってください。

vtbl 11 HRESULT GetProtocolHandles(HANDLE_PTR* pKeyboardHandle, HANDLE_PTR* pMouseHandle, HANDLE_PTR* pBeepHandle, HANDLE_PTR* pVideoHandle)

IWTSProtocolConnection::GetProtocolHandles は利用できなくなりました。

pKeyboardHandleHANDLE_PTR*outキーボードハンドルへのポインターです。これは I8042prt キーボードドライバー へのハンドルです。
pMouseHandleHANDLE_PTR*outマウスハンドルへのポインターです。これは Mouclass ドライバー へのハンドルです。
pBeepHandleHANDLE_PTR*outビープデバイスハンドルへのポインターです。このハンドルは使用されず、NULL に設定する必要があります。
pVideoHandleHANDLE_PTR*outビデオデバイスハンドルへのポインターです。これは、プロトコルに関連付けられたリモートセッションのビデオミニポートドライバーへのハンドルです。
vtbl 12 HRESULT ConnectNotify(DWORD SessionId)

IWTSProtocolConnection::ConnectNotify は利用できなくなりました。代わりに IWRdsProtocolConnection::ConnectNotify を使用してください。

SessionIdDWORDinクライアントに関連付けられたセッション ID を格納する整数です。

解説(Remarks)

これはイベント通知であり、このメソッドからは直ちに戻る必要があります。デッドロックの可能性を避けるため、直接的または間接的にリモートデスクトップサービス API の呼び出しにつながる関数呼び出しやメソッド呼び出しを行わないでください。外部への呼び出しを行う必要がある場合は、新しいスレッドを開始し、その新しいスレッドから外部への呼び出しを行ってください。

vtbl 13 HRESULT IsUserAllowedToLogon(DWORD SessionId, HANDLE_PTR UserToken, LPWSTR pDomainName, LPWSTR pUserName)

IWTSProtocolConnection::IsUserAllowedToLogon は利用できなくなりました。代わりに IWRdsProtocolConnection::IsUserAllowedToLogon を使用してください。

SessionIdDWORDinユーザーに関連付けられたセッション ID を格納する整数です。
UserTokenHANDLE_PTRinユーザートークンハンドルへのポインターです。
pDomainNameLPWSTRinユーザーのドメイン名を格納する文字列へのポインターです。
pUserNameLPWSTRinユーザー名を格納する文字列へのポインターです。
vtbl 14 HRESULT SessionArbitrationEnumeration(HANDLE_PTR hUserToken, BOOL bSingleSessionPerUserEnabled, DWORD* pSessionIdArray, DWORD* pdwSessionIdentifierCount)

IWTSProtocolConnection::SessionArbitrationEnumeration は利用できなくなりました。代わりに IWRdsProtocolConnection::SessionArbitrationEnumeration を使用してください。

hUserTokenHANDLE_PTRinユーザートークンハンドルへのポインターです。
bSingleSessionPerUserEnabledBOOLinユーザーを最大 1 つのセッションにのみ関連付けられるかどうかを指定するブール値です。
pSessionIdArrayDWORD*outユーザーの切断済みセッション ID を格納する整数の配列へのポインターです。
pdwSessionIdentifierCountDWORD*inoutpSessionIdArray パラメーターによって参照される切断済みセッション ID の数を指定する整数へのポインターです。

解説(Remarks)

リモートデスクトップサービスは、このユーザーが再接続できる既存のセッションを見つけるためにこのメソッドを呼び出します。このメソッドが HRESULT エラーコードを返す場合、またはセッション ID を 1 つも返さない場合、リモートデスクトップサービスは自身で調停を実行します。

vtbl 15 HRESULT LogonNotify(HANDLE_PTR hClientToken, LPWSTR wszUserName, LPWSTR wszDomainName, WTS_SESSION_ID* SessionId)

IWTSProtocolConnection::LogonNotify は利用できなくなりました。代わりに IWRdsProtocolConnection::LogonNotify を使用してください。

hClientTokenHANDLE_PTRinユーザートークンハンドルへのポインターです。
wszUserNameLPWSTRinユーザー名を格納する文字列へのポインターです。
wszDomainNameLPWSTRinユーザーのドメイン名を格納する文字列へのポインターです。
SessionIdWTS_SESSION_ID*inユーザーに関連付けられたセッション ID を格納する WTS_SESSION_ID 構造体へのポインターです。

解説(Remarks)

リモートデスクトップサービスは、セッションの状態が変化したときにもこのメソッドを呼び出します。

これはイベント通知であり、このメソッドからは直ちに戻る必要があります。デッドロックの可能性を避けるため、直接的または間接的に リモートデスクトップサービス API の呼び出しにつながる関数呼び出しやメソッド呼び出しを行わないでください。外部への呼び出しを行う必要がある場合は、新しいスレッドを開始し、その新しいスレッドから外部への呼び出しを行ってください。

vtbl 16 HRESULT GetUserData(WTS_POLICY_DATA* pPolicyData, WTS_USER_DATA* pClientData)

IWTSProtocolConnection::GetUserData は利用できなくなりました。代わりに IWRdsProtocolSettings::MergeSettings を使用してください。

pPolicyDataWTS_POLICY_DATA*inマージされたグループポリシー値を格納する WTS_POLICY_DATA 構造体へのポインターです。
pClientDataWTS_USER_DATA*inoutクライアントのプロパティ情報を格納する WTS_USER_DATA 構造体へのポインターです。

解説(Remarks)

リモートデスクトップサービスは、このメソッドを呼び出す前に、リスナー設定、クライアントから提供されたデータ、グループポリシーデータを含むすべてのポリシーデータをマージします。

vtbl 17 HRESULT DisconnectNotify()

IWTSProtocolConnection::DisconnectNotify は利用できなくなりました。代わりに IWRdsProtocolConnection::DisconnectNotify を使用してください。

解説(Remarks)

これはイベント通知であり、このメソッドからは直ちに戻る必要があります。デッドロックの可能性を避けるため、直接的または間接的にリモートデスクトップサービス API の呼び出しにつながる関数呼び出しやメソッド呼び出しを行わないでください。外部への呼び出しを行う必要がある場合は、新しいスレッドを開始し、その新しいスレッドから外部への呼び出しを行ってください。

vtbl 18 HRESULT Close()

IWTSProtocolConnection::Close は利用できなくなりました。代わりに IWRdsProtocolConnection::Close を使用してください。

解説(Remarks)

プロトコルは、接続を閉じて IWTSProtocolConnectionCallback オブジェクトを削除するために必要なクリーンアップを実行する必要があります。

vtbl 19 HRESULT GetProtocolStatus(WTS_PROTOCOL_STATUS* pProtocolStatus)

IWTSProtocolConnection::GetProtocolStatus は利用できなくなりました。代わりに IWRdsProtocolConnection::GetProtocolStatus を使用してください。

pProtocolStatusWTS_PROTOCOL_STATUS*outプロトコルのカウンター、シグナル、キャッシュ情報を格納する WTS_PROTOCOL_STATUS 構造体へのポインターです。
vtbl 20 HRESULT GetLastInputTime(ULONGLONG* pLastInputTime)

IWTSProtocolConnection::GetLastInputTime は利用できなくなりました。代わりに IWRdsProtocolConnection::GetLastInputTime を使用してください。

pLastInputTimeULONGLONG*out経過時間をミリ秒単位で格納する整数です。
vtbl 21 HRESULT SetErrorInfo(DWORD ulError)

IWTSProtocolConnection::SetErrorInfo は利用できなくなりました。代わりに IWRdsProtocolConnection::SetErrorInfo を使用してください。

ulErrorDWORDinエラーコードを格納する整数です。
vtbl 22 HRESULT SendBeep(DWORD Frequency, DWORD Duration)

IWTSProtocolConnection::SendBeep は利用できなくなりました。

FrequencyDWORDin37 から 32,767 ヘルツの範囲のパルス周波数を格納する整数です。
DurationDWORDinパルスの持続時間をミリ秒単位で格納する整数です。
vtbl 23 HRESULT CreateVirtualChannel(LPSTR szEndpointName, BOOL bStatic, DWORD RequestedPriority, UINT_PTR* phChannel)

IWTSProtocolConnection::CreateVirtualChannel は利用できなくなりました。代わりに IWRdsProtocolConnection::CreateVirtualChannel を使用してください。

szEndpointNameLPSTRin接続を一意に識別するエンドポイントデータを格納する文字列値です。
bStaticBOOLin仮想チャネルが静的か動的かを指定するブール値です。TRUE の値は静的チャネルを指定します。
RequestedPriorityDWORDin優先度を格納する整数です。
phChannelUINT_PTR*outチャネルハンドルへのポインターです。

解説(Remarks)

仮想チャネルは、リモートデスクトップサービスアプリケーションを拡張するために作成できるソフトウェア拡張機能です。例としては、追加のハードウェアのサポートや、特定のプロトコルによって提供される機能への追加などがあります。詳細については、リモートデスクトップサービスの仮想チャネル を参照してください。

vtbl 24 HRESULT QueryProperty(GUID QueryType, DWORD ulNumEntriesIn, DWORD ulNumEntriesOut, WTS_PROPERTY_VALUE* pPropertyEntriesIn, WTS_PROPERTY_VALUE* pPropertyEntriesOut)

IWTSProtocolConnection::QueryProperty は利用できなくなりました。代わりに IWRdsProtocolConnection::QueryProperty を使用してください。

QueryTypeGUIDin

プロパティを指定する GUID です。次のいずれかの値を指定できます。

WTS_QUERY_ALLOWED_INITIAL_APP (C77D1B30-5BE1-4c6b-A0E1-BD6D2E5C9FCC)

リモートデスクトップサービスによって送信され、初期アプリケーションの実行を許可するかどうかを判断します。

入力時、リモートデスクトップサービスは pPropertyEntriesIn パラメーターで 3 つの WTS_PROPERTY_VALUE 構造体を渡します。

入力構造体 1:

  • pPropertyEntriesIn[0].Type = WTS_VALUE_TYPE_STRING
  • pPropertyEntriesIn[0].u.strVal.pstrVal = アプリケーション名
  • pPropertyEntriesIn[0].u.strVal.size = 名前文字列の長さ
入力構造体 2:
  • pPropertyEntriesIn[1].Type = WTS_VALUE_TYPE_STRING
  • pPropertyEntriesIn[1].u.strVal.pstrVal = アプリケーションパラメーター
  • pPropertyEntriesIn[1].u.strVal.size = パラメーター文字列の長さ
入力構造体 3: 出力時、pPropertyEntriesOut パラメーターで次の 3 つの WTS_PROPERTY_VALUE 構造体を渡します。リモートデスクトップサービスによって渡されたアプリケーションを使用する場合は、入力構造体 1 と 2 を出力構造体 1 と 2 にコピーします。

出力構造体 1:

  • pPropertyEntriesOut[0].Type = WTS_VALUE_TYPE_STRING
  • pPropertyEntriesOut[0].u.strVal.pstrVal = ディレクトリを含むコマンドライン
  • pPropertyEntriesOut[0].u.strVal.size = コマンドラインの長さ
出力構造体 2:
  • pPropertyEntriesOut[1].Type = WTS_VALUE_TYPE_STRING
  • pPropertyEntriesOut[1].u.strVal.pstrVal = アプリケーションパラメーター
  • pPropertyEntriesOut[1].u.strVal.size = パラメーター文字列の長さ
出力構造体 3:
  • pPropertyEntriesOut[2].Type = WTS_VALUE_TYPE_ULONG
  • pPropertyEntriesOut[2].u.ulVal = アプリケーションを実行する場合は 0 以外の任意の値、停止する場合は 0

WTS_QUERY_LOGON_SCREEN_SIZE (8b8e0fe7-0804-4a0e-b279-8660b1df0049)

WinLogon がログオン画面のサイズを判断するために使用します。

pPropertyEntriesIn パラメーターは NULL になります。

pPropertyEntriesOut パラメーターを次のように設定します。

  • pPropertyEntriesOut[0].Type = WTS_VALUE_TYPE_ULONG
  • pPropertyEntriesOut[0].u.ulVal = 画面サイズ
既定の画面サイズを使用しない場合、プロトコルは E_NOTIMPL を返す必要があります。

WTS_QUERY_AUDIOENUM_DLL (9bf4fa97-c883-4c2a-80ab-5a39c9af00db)

リモートデスクトップサービスが、リモートオーディオ列挙子 DLL の名前を照会するために使用します。

pPropertyEntriesIn パラメーターは NULL になります。

pPropertyEntriesOut パラメーターを次のように設定します。

pstrVal のメモリは LocalAlloc 関数を使用して割り当てる必要があります。

WTS_QUERY_MF_FORMAT_SUPPORT (41869ad0-6332-4dc8-95d5-db749e2f1d94)

リモートデスクトップ Media Foundation プラグインが、特定のメディア形式に使用するシンクオブジェクトを判断するために使用します。

入力時、RCM は pPropertyEntriesIn パラメーターで次の WTS_PROPERTY_VALUE 構造体を渡します。

出力時、pPropertyEntriesOut パラメーターで次の WTS_PROPERTY_VALUE 構造体を渡します。

PROPERTY_DYNAMIC_TIME_ZONE_INFORMATION (cdfd28e-d0b9-4c1f-a5eb-6d1f6c6535b9)

接続から動的なタイムゾーン情報を取得するために使用します。

pPropertyEntriesIn パラメーターは NULL になります。

出力時、pPropertyEntriesOut パラメーターで次の WRDS_PROPERTY_VALUE 構造体を渡します。

ulNumEntriesInDWORDinpPropertyEntriesIn 引数で渡される WTS_PROPERTY_VALUE 構造体の数を格納する整数です。
ulNumEntriesOutDWORDinpPropertyEntriesOut 引数で渡される WTS_PROPERTY_VALUE 構造体の数を格納する整数です。
pPropertyEntriesInWTS_PROPERTY_VALUE*in要求されたプロパティ情報を見つけるのに役立てられる 1 つ以上の WTS_PROPERTY_VALUE 構造体です。
pPropertyEntriesOutWTS_PROPERTY_VALUE*out要求されたプロパティ情報を格納する 1 つ以上の WTS_PROPERTY_VALUE 構造体です。
vtbl 25 HRESULT GetShadowConnection(IWTSProtocolShadowConnection** ppShadowConnection)

IWTSProtocolConnection::GetShadowConnection は利用できなくなりました。代わりに IWRdsProtocolConnection::GetShadowConnection を使用してください。

ppShadowConnectionIWTSProtocolShadowConnection**outIWTSProtocolShadowConnection インターフェイスへのポインターのアドレスです。
出典・ライセンス: 上記「公式ドキュメント」の内容は 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_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 指定が可能。