IMsRdpExtendedSettings::Property 属性

包含命名属性。

此属性是可读写的。

语法

HRESULT put_Property(
  [in]          BSTR    bstrPropertyName,
  [in]          VARIANT *pValue
);

HRESULT get_Property(
  [in]          BSTR    bstrPropertyName,
  [out, retval] VARIANT *pValue
);

属性值

命名属性值。

属性名称 数据类型 Access 可以在连接启动后更改 说明
ConnectToChildSession VT_BOOL 读取/写入 将此属性设置为 True 会导致客户端控件连接到本地计算机(而不是远程服务器)上的子会话。 如果将此属性设置为 true,则无法连接到远程服务器,因为所有连接会重定向到 localhost。 有关子会话的详细信息,请参阅子会话
DisableCredentialsDelegation VT_BOOL 读取/写入 如果为 True,则凭据将不会发送到远程服务器。
EnableFrameBufferRedirection VT_BOOL 读取/写入 如果为 True,则尝试帧缓冲区重定向。 对于环回连接(同一台计算机同时充当客户端和服务器),帧缓冲区重定向可支持在会话之间共享帧缓冲区的内存。
EnableHardwareMode VT_BOOL 仅写入 如果为 True,则会尝试使用硬件协助进行图形解码。
IgnoreCursors VT_BOOL 仅写入 如果为 True,则忽略远程服务器发送的光标。
ManualClipboardSyncEnabled VT_BOOL 读取/写入 将此属性设置为 True 意味着本地和远程剪贴板将不会自动保持同步。相反,必须使用 IMsRdpClipboard 接口将剪贴板格式从本地剪贴板同步到远程剪贴板,并从远程剪贴板同步到本地剪贴板。
ZoomLevel VT_UI4 读取/写入 通过使用 RDP ActiveX 控件实现“缩放”功能。 RDP 的“系统”菜单提供了“缩放”功能。 ZoomLevel 属性在 RemoteApp 模式和全屏模式下不起作用。 IMsRdpClientAdvancedSettings::SmartSizingZoomLevel 是互斥的。
DisableSeamlessLanguageBar VT_BOOL R/W 如果为 True,这会导致 RemoteApp 连接还原到 Windows 8 以前的旧式语言栏,而不是自动将本地语言同步到远程会话。 
RedirectTextProcessing VT_BOOL W 从 Windows 11 23H2 开始,可启用/禁用为文本输入方案(例如 IME、表情符号)提供类似本地体验的文本处理重定向。 
HvSocketServiceId VT_BSTR W 指定要发送 RDP 流量的 Hyper-V 套接字地址的 ServiceId 字段。 
DeviceScaleFactor VT_UI4 R/W 指定远程会话中使用的设备缩放因子
有效值:100、140、180
EnableLocationRedirection VT_BOOL R/W 启用/禁用本地计算机位置到远程会话的重定向。 
AudioCaptureDevice VT_BSTR R/W 指定要从客户端重定向到远程会话的音频捕获设备的设备 ID。
应用程序可以使用 DRV_QUERYFUNCTIONINSTANCEID 消息来确定要重定向的音频捕获设备的设备 ID。
或者可以将此项设置为“默认”,以使用默认设备,也可以设置为“无”以禁用音频捕获。 默认情况下,此项设置为 true。
RailMode VT_BOOL R 报告此连接是否为 RemoteApp 连接。 ITSRemoteProgram::RemoteProgramMode 可写入到此属性。 
EnableRdsAadAuth VT_BOOL W 如果为 True,则使用 RDS AAD 身份验证安全。 
RDGIsKDCProxy VT_BOOL W 如果为 True,则告知客户端使用 RD 网关(如果指定)作为 KDC 代理服务器。 
UseURCP VT_BOOL R/W 如果为 True,则此属性会为基于 UDP 的远程桌面连接启用通用速率控制协议。 目前,它默认处于禁用状态。 如果正在使用 UDP,则建议启用它。 
DesktopScaleFactor VT_UI4 R/W 指定远程会话中使用的设备缩放因子。 值应介于 100 和 500 之间(百分比)。 
RedirectedAuthentication VT_BOOL W 如果为 True,则启用远程凭据防护。 
RestrictedLogon VT_BOOL W 如果为 True,则启用受限管理员模式。 
AudioPlaybackDevice VT_BSTR R/W 指定本地计算机上音频播放设备的设备 ID。
应用程序可以使用 DRV_QUERYFUNCTIONINSTANCEID 消息来确定要重定向的音频播放设备的设备 ID。
“或者,可以将此项设置为“默认”,以使用默认设备,或设置为“无”以禁用音频播放。 默认情况下,此项设置为“默认”。 "
SelectedMonitors VT_BSTR R/W 以逗号分隔或以分号分隔的监视器 ID 列表,用于标识要在其中显示远程会话的所选监视器。 列表中的第一个 ID 将被视为远程会话中的主监视器。 
WslgModeEnabled VT_BOOL W 如果为 True,则会话为 WSLg 会话。
应提供以下属性:
  • WslgSharedMemoryPath
  • HvSocketEnabled
  • HvSocketServiceId

请参阅 WSLg 的文档 https://github.com/microsoft/wslg
ShowSessionDiagnostics VT_BOOL W True 写入此属性会立即显示一个对话框,其中包含有关远程会话的详细信息。
此属性旨在成为调试机制。 它可能会更改和移除。 
PrintingProgressMode VT_UI4 R/W 可能的值:
  • 0:禁用打印时显示的进度对话框
  • 1:打印包含基本信息时显示的进度对话框
  • 2:打印包含详细信息时显示的进度对话框
CorrelationId VT_BOOL W 替代由 IMsRdpClientNonScriptable8::CorrelationId 返回的值。 
RequestUseNewOutputPresenter VT_BOOL W 如果为 True,则仅使用 DirectX 显示远程会话,而不回退到 GDI。 此属性不适用于远程应用会话。
注意:由于仅限 DirectX 模式可能成为唯一可用的选项,因此,将来的 Windows 版本中可能会移除此属性。 这是目前不应在生产代码中启用的预览功能。
GatewayCertificateLogonAuthority VT_BSTR W 此属性已不再受支持。 在将来的 Windows 版本中,可能会将其移除。 请勿使用此属性。 
EnableRemoteEdgeBar VT_BOOL R/W 如果为 True,并且 ServerSupportsEdgeActions 属性为 True,则远程会话的连接工具栏中会显示其他命令。 
TSGTransportIsUsed VT_BOOL R N/A 如果为 True,则远程桌面网关将用于关联的远程会话。 
DiagnosticsInfo VT_BSTR W 表示客户端 X.224 连接请求 PDUrdpCorrelationInfo.correlationId 字段的十六进制字符串。 
EndpointFedAuth VT_BSTR W 用于基于声明的联合 RDSTLS 身份验证的令牌。 
AllowAxToContainerEvents VT_BOOL W 此属性已添加在 Windows 11 22H2 中。
  • 如果为 False(从 Windows 11 22H2 开始的默认行为),则会将 Ctrl+Alt+箭头键组合发送到远程会话。
  • 如果为 True(Windows 11 22H2 之前的默认行为),则按 Ctrl+Alt+箭头键组合会将 IMsTscAxEvents::OnFocusReleased 事件引发到应用程序。
ServerSupportsEdgeActions VT_BOOL R N/A 只读属性,用于确定远程会话是否具有 RNS_UD_SC_EDGE_ACTIONS_SUPPORTED_V1 功能 https://learn.microsoft.com/openspecs/windows_protocols/ms-rdpbcgr/379a020e-9925-4b4f-98f3-7d634e10b411。 
AppContainerID VT_BSTR W 调用 IMsRdpClientNonScriptable8::StartWorkspaceExtension 时传递到 IWorkspaceScriptable3::StartWorkspaceEx2 的 AppContainer ID。
注意:RemoteApp 和桌面连接控制面板不再处于活动开发阶段。 它在将来的 Windows 版本中可能会更改或不可用。 不建议使用此 API。
IgnoreServerGeneratedMouseMoves VT_BOOL R/W 如果为 True,则将忽略远程会话中以编程方式生成的鼠标移动。 更确切地说,不会应用指针位置更新 PDU。 请参阅 https://learn.microsoft.com/openspecs/windows_protocols/ms-rdpbcgr/3058381e-c856-4b26-a93c-d8f5514f8c3c。 
RDmiDiagnosticsUrl VT_BSTR W 此属性已不再受支持。 在将来的 Windows 版本中,可能会将其移除。 请勿使用此属性。 
EnableVailMonitorConfig VT_BOOL R/W 如果为 True,则在同步显示配置时,扩展监视器信息(例如 EDID)将发送到远程会话。 
工作区 ID VT_BSTR W 远程会话所属的 RemoteApp 和桌面连接中连接的唯一标识符。 
ShowConnectionInformation VT_BOOL W True 写入此属性会显示“连接信息”对话框。 
WslgSharedMemoryPath VT_BSTR W 用于与 WSLg 虚拟机共享图形缓冲区的内存会话对象的路径。 
HiDefRemoteAppContainerGUID VT_BSTR W 与托管远程应用程序的正在运行的 VM 关联的 GUID。 由于内存共享,写入此属性可以提高在本地 VM 中运行的远程应用程序的性能。 
KDCProxyName VT_BSTR W “指定密钥分发中心 (KDC) 代理服务器的完全限定域名。 KDC 代理支持 RDP 客户端在无法直接访问 KDC 时使用 Kerberos 身份验证协议。  属性值的示例:“kdc.contoso.com”。。 有关详细信息,请参阅:配置 Kerberos 密钥分发中心代理https://learn.microsoft.com/openspecs/windows_protocols/MS-KKDCP/5bcebb8d-b747-4ee5-9453-428aec1c5c38
DisableTouchRemoting VT_BOOL R/W 如果为 True,多点触控屏幕上的手势将不会发送到远程服务器。 默认情况下,此项设置为 False。 
HvSocketEnabled VT_BOOL W 如果 True,则远程服务器的名称(如果为 GUID)会解释为要发送 RDP 流量的 Hyper-V 套接字地址的 VmId 字段。 默认情况下,此项设置为 False
有关 Hyper-V 套接字地址的详细信息,请参阅绑定到 Hyper-V 套接字。 
MultipenRemotingSupported VT_BOOL W 如果为 True,则远程会话支持同时注入最多四个笔设备的输入。 默认情况下,此项设置为 False。 
ShowGatewayInformation VT_BOOL W True 写入此属性会显示一个对话框,其中显示了有关远程桌面网关的信息。
Windows 11 22H2 及更高版本:此属性已不再受支持,并且已替换为 ShowConnectionInformation 属性。

要求

要求
最低受支持的客户端
Windows 8
最低受支持的服务器
Windows Server 2012
类型库
MsTscAx.dll
DLL
MsTscAx.dll
CLSID
CLSID_MsRdpClient7NotSafeForScripting 定义为 54d38bf7-b1ef-4479-9674-1bd6ea465258
CLSID_MsRdpClient8NotSafeForScripting 定义为 A3BC03A0-041D-42E3-AD22-882B7865C9C5
CLSID_MsRdpClient9NotSafeForScripting 定义为 8B918B82-7985-4C24-89DF-C33AD2BBFBCD
IID
IID_IMsRdpExtendedSettings 定义为 302D8188-0052-4807-806A-362B628F9AC5

另请参阅

IMsRdpExtendedSettings