IRDPSRAPIViewer::Connect メソッド (rdpencomapi.h)
[IRDPSRAPIViewer インターフェイスは、Windows 10 バージョン 1709 の時点で UWP アプリケーションで使用できなくなりました。 デスクトップ アプリでは引き続きサポートされています。]
共有子への実際の接続を開始します。
構文
HRESULT Connect(
[in] BSTR bstrConnectionString,
[in] BSTR bstrName,
[in] BSTR bstrPassword
);
パラメーター
[in] bstrConnectionString
種類: BSTR
接続文字列共有者に接続し、ビューアーを認証するために使用されます。
[in] bstrName
種類: BSTR
ビューアーの名前。 名前は、共有者やその他の閲覧者に送信されます。 文字列は 255 文字に制限されています。
[in] bstrPassword
種類: BSTR
認証に使用されるパスワード。 パスワードは、共有元から帯域外で送信されます。
戻り値
型: HRESULT
メソッドが成功した場合、戻り値は S_OK。 それ以外の場合、戻り値はエラー コードです。
注釈
bstrConnectionString パラメーターに含まれる接続文字列は、共有者によって生成され、次の手順を実行してビューアーによって取得されます。
- 共有元は、IRDPSRAPISharingSession::Invitations プロパティから IRDPSRAPIInvitationManager インターフェイスのインスタンスを取得します。
- 共有者は 、IRDPSRAPIInvitationManager::CreateInvitation メソッドを呼び出して 、IRDPSRAPIInvitation インターフェイスの インスタンスを取得します。
- 共有者は、IRDPSRAPIInvitation::ConnectionString プロパティから接続文字列を取得します。
- 共有者は、接続文字列をファイルに格納し、ビューアーとファイルを共有するなど、アプリケーション定義のメソッドで接続文字列をビューアーに送信します。
このプロパティに設定されている bstrName 文字列は、接続の開始後に共有側に送信されます。 プロパティは、共有アプリケーションが表示するために選択できるフレンドリ名です。 プロパティは、共有者と他の閲覧者が Windows デスクトップ共有セッションに参加しているユーザーを識別できるため、招待を使用して複数の出席者を認証する場合に便利です。
要件
| 要件 | 値 |
|---|---|
| サポートされている最小のクライアント | Windows Vista [デスクトップ アプリのみ] |
| サポートされている最小のサーバー | Windows Server 2008 [デスクトップ アプリのみ] |
| 対象プラットフォーム | Windows |
| ヘッダー | rdpencomapi.h |
| [DLL] | RdpEncom.dll |