IRemoteDesktopClientSettings::SetRdpProperty メソッド (rdpappcontainerclient.h)

[アーティクル]
03/01/2024

1 つの名前付き RDP プロパティの値を設定します。

構文

HRESULT SetRdpProperty(
  [in] BSTR    propertyName,
  [in] VARIANT value
);

パラメーター

[in] propertyName

プロパティの名前を指定する文字列。

メモこれらの文字列値では、大文字と小文字は区別されません。

使用できる値は次のとおりです。

"管理セッション" (ブール値)

セッションが管理セッションかどうかを指定します。これには、次のいずれかの値を指定できます。

false

セッションは管理セッションではありません。

True

セッションは管理セッションです。

"フォントのスムージングを許可する" (ブール値)

リモートセッションでフォントのスムージングを許可するかどうかを指定します。これには、次のいずれかの値を指定できます。

false

フォントのスムージングは使用できません。

True

フォントのスムージングを使用できます。

"代替完全アドレス" (文字列)

接続するリモートコンピューターの代替名または IP アドレスを指定します。

"audiocapturemode" (ブール値)

オーディオ入力キャプチャモードを指定します。これには、次のいずれかの値を指定できます。

false

オーディオ入力をキャプチャしないでください。

True

オーディオ入力をキャプチャします。

"audiomode" (数値)

サウンドを再生する場所を指定します。これには、次のいずれかの値を指定できます。

0

クライアントコンピューターでサウンドを再生します。

1

ホストコンピューターでサウンドを再生します。

2

サウンドを再生しないでください。

"認証レベル" (数値)

リモートセッションの認証レベルを指定します。これには、次のいずれかの値を指定できます。

0

[なし] :

1

認証の要求

2

認証は交渉可能です。

3

認証が指定されていません。

"接続の種類" (数値)

接続の種類を指定します。これには、次のいずれかの値を指定できます。

1

モデム

2

低速ブロードバンド

3

衛星

4

高速ブロードバンド

5

WAN

6

LAN

7

自動検出

Cookie ベースの認証サーバーのアドレスを指定します。

"desktopheight" (数値)

仮想デスクトップの高さをピクセル単位で指定します。

"desktopwidth" (数値)

仮想デスクトップの幅をピクセル単位で指定します。

"ウィンドウ全体のドラッグを無効にする" (ブール値)

ドラッグ中にウィンドウの内容を表示するかどうかを指定します。これには、次のいずれかの値を指定できます。

false

有効

True

無効

メニューアニメーションの表示を無効にするかどうかを指定します。これには、次のいずれかの値を指定できます。

false

有効

True

無効

"テーマを無効にする" (ブール値)

テーマを無効にするかどうかを指定します。これには、次のいずれかの値を指定できます。

false

有効

True

無効

"壁紙を無効にする" (ブール値)

壁紙を表示するかどうかを指定します。これには、次のいずれかの値を指定できます。

false

壁紙が表示されます。

True

壁紙は表示されません。

"domain" (String)

リモートセッションへの接続に使用するドメインを指定します。

"enablecredsspsupport" (ブール値)

リモートセッションに CredSSP ベースの認証を使用するかどうかを指定します。これには、次のいずれかの値を指定できます。

false

CredSSP ベースの認証は使用しないでください。

True

CredSSP ベースの認証を使用します。

"full address" (String)

接続先のコンピューターのアドレスを指定します。

"gatewaycredentialssource" (数値)

リモートデスクトップゲートウェイの資格情報のソースを指定します。これには、次のいずれかの値を指定できます。

0

ユーザーに資格情報の入力を求め、NTLM 認証を使用します。

1

資格情報にはスマートカードを使用します。

2

現在ログオンしているユーザーの資格情報を使用します。

3

ユーザーに資格情報の入力を求め、基本認証を使用します。

4

ユーザーはログオン時に資格情報ソースを選択します。

5

Cookie ベースの認証を使用します。

"gatewayhostname" (String)

リモートデスクトップゲートウェイサーバー名を指定します。

"gatewayprofileusagemethod" (数値)

リモートデスクトップゲートウェイプロファイルの使用状況を指定します。これには、次のいずれかの値を指定できます。

0

ゲートウェイプロファイルの設定 (存在する場合) を使用します。

1

ゲートウェイプロファイルが存在する場合でも、明示的なゲートウェイ設定を使用します。

"gatewayusagemethod" (数値)

リモートデスクトップゲートウェイの使用状況を指定します。これには、次のいずれかの値を指定できます。

0

リモートデスクトップゲートウェイサーバーは使用しないでください。 [ローカルアドレスの RD ゲートウェイサーバーをバイパスチェック] ボックスがオフです。

1

"gatewayhostname" プロパティで指定されたリモートデスクトップゲートウェイを使用します。

2

リモートデスクトップゲートウェイサーバーの設定を自動的に検出します。

3

[リモートデスクトップゲートウェイの使用設定] の既定の設定を使用します。

4

リモートデスクトップゲートウェイサーバーは使用しないでください。 [ローカルアドレスの RD ゲートウェイサーバーをバイパスチェック] ボックスが選択されています。

"高解像度マウス" (ブール値)

マウス入力の解像度モードを指定します。これには、次のいずれかの値を指定できます。

false

マウス入力が合体されます。マウスデータはサブサンプリングされ、既定のサンプリングレートに従って送信されます。

True

マウス入力は合体されません。マウスデータはフル解像度で送信されます。

"loadbalanceinfo" (String)

クライアントコンピューターに最適なサーバーを選択するために使用される負荷分散 Cookie が含まれます。

ログイン Web ページのアドレスを指定します。

"事前認証サーバーアドレス" (文字列)

事前認証サーバーのアドレスを指定します。

"資格情報の入力を求める" (ブール値)

ユーザーに資格情報の入力を求めるかどうかを指定します。これには、次のいずれかの値を指定できます。

false

ユーザーは資格情報の入力を求められません。

True

ユーザーに資格情報の入力を求められます。

"promptcredentialonce" (数値)

リモートデスクトップゲートウェイの資格情報共有を有効にするかどうかを指定します。これには、次のいずれかの値を指定できます。

0

資格情報の共有が無効になっています。

1

資格情報の共有が有効になっています。

"redirectclipboard" (ブール値)

クライアントのクリップボードをリモートセッションにリダイレクトするかどうかを指定します。これには、次のいずれかの値を指定できます。

false

クリップボードはリダイレクトされません。

True

クリップボードがリダイレクトされます。

"redirectprinters" (ブール値)

クライアントのプリンターをリモートセッションにリダイレクトするかどうかを指定します。これには、次のいずれかの値を指定できます。

false

プリンターはリダイレクトされません。

True

プリンターがリダイレクトされます。

"事前認証が必要" (数値)

事前認証が必要かどうかを指定します。これには、次のいずれかの値を指定できます。

0

事前認証は必要ありません。

1

事前認証が必要です。

"サポート URL" (文字列)

サポート情報を取得する URL を指定します。

Boolean

"リダイレクトサーバー名の使用" (ブール値)

リダイレクトサーバーを許可するかどうかを指定します。次のいずれかの値を指定できます。

false

リダイレクトサーバーは許可されません。

True

リダイレクトサーバーは許可されます。

"username" (文字列)

リモートセッションへの接続に使用するユーザー名を指定します。

"WinRTEncryptedPassword" (String)

暗号化されたパスワードを指定します。このプロパティを設定するには、次のアクションを実行する必要があります。

CryptographicBuffer クラスの ConvertStringToBinary メソッドを使用して、クリアテキストパスワードをバイナリに変換します。
手順 1 で ConvertStringToBinary メソッドに渡したエンコードパラメーターに相当する値を使用して、WinRTPasswordEncoding プロパティを設定します。
入力文字列に "LOCAL=user" を渡して、DataProtectionProvider(String) メソッドを呼び出します。
ProtectAsync メソッドを呼び出して、パスワードを含むバイナリ文字列を暗号化します。
ProtectAsync メソッドによって返される CryptographicBuffer オブジェクトを、EncodeToBase64String メソッドを使用して Base64 でエンコードされた値に変換します。
手順 5 で取得した Base64 エンコード文字列を使用して、このプロパティ (WinRTEncryptedPassword) を設定します。

"WinRTPasswordEncoding" (数値)

暗号化されたパスワードに適用できるエンコードの種類を指定します。次のいずれかの値を指定できます。既定値は 1 です。このプロパティは、 WinRTEncryptedPassword プロパティを設定する前に設定する必要があります。

0

UTF8

1

UTF16LE

2

UTF16BE

"ワークスペース ID" (文字列)

この RDP ファイルが一部として発行されている RemoteApp およびデスクトップ接続ワークスペースの識別子を指定します。

[in] value

新しいプロパティ値。

戻り値

このメソッドは、成功すると S_OK を返します。そうでない場合は、HRESULT エラーコードを返します。

要件

要件	値
サポートされている最小のクライアント	Windows 8
サポートされている最小のサーバー	Windows Server 2012
対象プラットフォーム	Windows
ヘッダー	rdpappcontainerclient.h
[DLL]	MsTscAx.dll

こちらもご覧ください

IRemoteDesktopClientSettings

次の方法で共有

IRemoteDesktopClientSettings::SetRdpProperty メソッド (rdpappcontainerclient.h)

構文

パラメーター

"管理セッション" (ブール値)

false

True

"フォントのスムージングを許可する" (ブール値)

false

True

"代替完全アドレス" (文字列)

"audiocapturemode" (ブール値)

false

True

"audiomode" (数値)

0

1

2

"認証レベル" (数値)

0

1

2

3

"接続の種類" (数値)

1

2

3

4

5

6

7

"Cookie ベースの認証サーバー アドレス" (文字列)

"desktopheight" (数値)

"desktopwidth" (数値)

"ウィンドウ全体のドラッグを無効にする" (ブール値)

false

True

"disable menu anims" (Boolean)

false

True

"テーマを無効にする" (ブール値)

false

True

"壁紙を無効にする" (ブール値)

false

True

"domain" (String)

"enablecredsspsupport" (ブール値)

false

True

"full address" (String)

"gatewaycredentialssource" (数値)

0

1

2

3

4

5

"gatewayhostname" (String)

"gatewayprofileusagemethod" (数値)

0

1

"gatewayusagemethod" (数値)

0

1

2

3

4

"高解像度マウス" (ブール値)

false

True

"loadbalanceinfo" (String)

"ログイン Web ページ アドレス" (文字列)

"事前認証サーバー アドレス" (文字列)

"資格情報の入力を求める" (ブール値)

false

True

"promptcredentialonce" (数値)

0

1

"Cookie ベースの認証サーバーアドレス" (文字列)

"ログイン Web ページアドレス" (文字列)

"事前認証サーバーアドレス" (文字列)

"リダイレクトサーバー名の使用" (ブール値)