IRDPSRAPISessionProperties::p ut_Property 方法 (rdpencomapi.h)

设置或获取命名会话属性。

此属性是可读写的。

语法

HRESULT put_Property(
  BSTR    PropertyName,
  VARIANT newVal
);

参数

PropertyName

newVal

返回值

备注

可以设置并获取以下属性。 属性名称区分大小写。

属性名称 属性说明 值类型
“DrvConAttach”
注意DrvConAttach 属性自Windows 10起不再可供使用。 不再有用于共享的镜像驱动程序
 
镜像驱动程序附件有两种模式。 第一种是动态加载模式。 在此模式下,镜像驱动程序将在与会者连接到会话并具有视图控制后立即附加。 当最后一个与会者离开会话 (或者没有具有视图控制) 的与会者时,将自动分离镜像驱动程序。

第二种模式是静态加载模式。 在此模式下,镜像驱动程序在会话打开后立即加载,在会话终止之前不会卸载。

请注意,在这两种模式下,驱动程序可能会因外部事件(如更改屏幕分辨率或共享颜色深度)而分离并重新附加。

对于动态附件模式,将此属性设置为 VARIANT_TRUE;对于静态附件模式,将此属性设置为 VARIANT_FALSE。 请注意,只能在调用 IRDPSRAPISharingSession::Open 方法之前设置此属性;调用 Open 方法后,此属性变为只读。 默认值为 VARIANT_TRUE。

对于 1:1 方案(如远程协助),应使用动态加载模式,因为从会话打开到专家连接的那一刻,可能需要很长时间。

对于 1:M (多方) 方案,应使用静态加载模式,因为附加和分离镜像驱动程序非常中断,除非有充分的理由,否则不应执行此操作。

VT_BOOL
“PortId” 用于从共享者传入连接的侦听器端口。 此属性也可在查看器端设置,但仅用于侦听反向连接时的连接。 VT_I4
“PortProtocol” 指定要在共享器上启动侦听器的协议系列。 可能的值如下:
AF_UNSPEC
值:0

地址系列未指定。

AF_INET
值:2

Internet 协议版本 4 (IPv4) 地址系列。

AF_INET6
值:23

Internet 协议版本 6 (IPv6) 地址系列。

VT_I4
“SetNetworkStream” 指向支持 IRDPSRAPITransportStream 接口的 IUnknown 接口的指针。 如果设置了此属性,则 Connect 方法将使用此流并忽略传递连接字符串。

此属性仅对查看器端有效。

VT_UNKNOWN
“EnforceStrongEncryption” 如果此属性的值为 VARIANT_TRUE,则共享者要求查看者使用符合 140 标准的联邦信息处理标准 (FIPS) 。 默认值为 VARIANT_FALSE。

调用 IRDPSRAPISharingSession::Open 方法后,此属性变为只读。 只能在调用该方法之前设置此属性。

Windows 10版本 1709 中添加了对 FIPS 140 合规性的查看器支持。 共享者拒绝Windows 10版本 1709 之前的查看器版本的连接。

此属性仅对共享方有效。

VT_BOOL
“FrameCaptureIntervalInMs” 指定帧捕获间隔。 默认情况下,帧捕获间隔为 33 毫秒,对应于每秒 30 帧。

可以使用此属性来优化性能。 如果屏幕更新不需要频繁执行,则可以增加捕获间隔。 例如,值为 400 毫秒会导致每秒 2.5 帧。

此属性仅对共享方有效。

VT_I4
“DefaultAttendeeControlLevel” 指定与会者的默认控制级别。 默认情况下,此值CTRL_LEVEL_NONE (无) 。 可以将此值更改为CTRL_LEVEL_VIEW (视图) 。

默认控制级别不能设置为交互。

此属性仅对共享方有效。

VT_I4
“EnableClipboardRedirect” 如果此属性的值为 VARIANT_TRUE,则会激活共享者和查看器之间的剪贴板。 默认值为 VARIANT_FALSE。

若要使用剪贴板共享,会话必须处于交互模式。

只有单个连接可以共享剪贴板。 最近获取的输入控件接管剪贴板共享的连接。 以前任何连接的剪贴板共享将自动禁用。

此属性只能用于桌面应用。

此属性仅对共享方有效。

此属性从 Windows 10 版本 1511 开始可用。

VT_BOOL
“SetClipboardRedirectCallback” 指定指向 IRDPSRAPIClipboardUseEvents 实例的 IUnknown 指针,该实例在每次尝试从共享计算机复制到查看器时接收回调。 仅当启用了剪贴板共享时,此属性才相关。

调用 IRDPSRAPISharingSession::Open 方法后,此属性变为只读。 只能在调用该方法之前设置此属性。

此属性只能用于桌面应用。

此属性仅对共享方有效。

此属性从 Windows 10 版本 1511 开始可用。

VT_UNKNOWN
“EnabledTransports” 指定要启用的传输。 值 3 支持 TCP 和 UDP。 默认值为 1,即仅 TCP。

调用 IRDPSRAPISharingSession::Open 方法后,此属性变为只读。 只能在调用该方法之前设置此属性。

此属性从 Windows 10 版本 1803 开始可用。

此属性仅对共享方有效。

VT_I4

要求

要求
最低受支持的客户端 Windows Vista [桌面应用 | UWP 应用]
最低受支持的服务器 Windows Server 2008 [桌面应用 | UWP 应用]
目标平台 Windows
标头 rdpencomapi.h
DLL RdpEncom.dll

另请参阅

IRDPSRAPISessionProperties