Edit

IRDPSRAPISessionProperties::get_Property method (rdpencomapi.h)

  • Article

Sets or gets a named session property.

This property is read/write.

Syntax

HRESULT get_Property(
  BSTR    PropertyName,
  VARIANT *pVal
);

Parameters

PropertyName

pVal

Return value

None

Remarks

You can set and get the following properties. The property names are case-sensitive.

Property name Property description Value type
"DrvConAttach"
Note  The DrvConAttach property is no longer available for use as of Windows 10. There is no longer a mirror driver for sharing.
 
There are two modes for the mirror driver attachment. The first is dynamic load mode. In this mode, the mirror driver will be attached immediately after an attendee is connected to the session and it has view control. The mirror driver will be automatically detached when the last attendee leaves the session (or there are no attendees with view control).

The second mode is static load mode. In this mode, the mirror driver is loaded immediately after the session is opened and is not unloaded until the session terminates.

Note that in both modes the driver might be detached and re-attached as a result of external events like changing the screen resolution or sharing color depth.

Set this property to VARIANT_TRUE for dynamic attachment mode and to VARIANT_FALSE for the static attachment mode. Note that you can set this property only before calling the IRDPSRAPISharingSession::Open method; this property becomes read-only after the Open method is called. The default is VARIANT_TRUE.

For 1:1 scenarios such as Remote Assistance, you should use the dynamic load mode because it can take a very long time between the moment the session is opened and the moment an expert will connect.

For 1:M (multiparty) scenarios, you should use the static load mode because attaching and detaching the mirror driver is quite disruptive and should not be done unless there is a good reason.

 VT_BOOL
"PortId" Listener port for incoming connections from sharer. This property can be set on viewer side as well but will be used only for listening to connections in case of a reverse connect. VT_I4
"PortProtocol" Specifies the protocol family to start the listener on sharer. The possible values are as follows:
AF_UNSPEC
Value: 0

The address family is unspecified.

AF_INET
Value: 2

The Internet Protocol version 4 (IPv4) address family.

AF_INET6
Value: 23

The Internet Protocol version 6 (IPv6) address family.

 VT_I4
"SetNetworkStream" A pointer to an IUnknown interface that supports the IRDPSRAPITransportStream interface. If this property is set, the Connect method will use this stream and ignore the connection string passed.

This property is valid for the viewer side only.

 VT_UNKNOWN
"EnforceStrongEncryption" If this property has a value of VARIANT_TRUE, the sharer requires the viewer to use Federal Information Processing Standard (FIPS) 140 compliant encryption. The default is VARIANT_FALSE.

This property becomes read-only after the IRDPSRAPISharingSession::Open method is called. You can set this property only before calling that method.

Viewer support for FIPS 140 compliance was added in Windows 10, version 1709. The sharer rejects connections from viewer versions previous to Windows 10, version 1709.

This property is valid for the sharer side only.

 VT_BOOL
"FrameCaptureIntervalInMs" Specifies the frame capture interval. By default, the frame capture interval is 33 milliseconds, which corresponds to 30 frames per second.

You can use this property to optimize performance. If screen updates do not need to be done so frequently, the capture interval can be increased. For example, a value of 400 milliseconds results in 2.5 frames per second.

This property is valid for the sharer side only.

 VT_I4
"DefaultAttendeeControlLevel" Specifies the default control level for attendees. By default, this value is CTRL_LEVEL_NONE (none). You can change this value to CTRL_LEVEL_VIEW (view).

The default control level cannot be set to interactive.

This property is valid for the sharer side only.

 VT_I4
"EnableClipboardRedirect" If this property has a value of VARIANT_TRUE, the clipboard between sharer and viewer is activated. The default is VARIANT_FALSE.

To use clipboard sharing, the session must be in interactive mode.

Only a single connection can share the clipboard. The connection that most recently acquired input control takes over clipboard sharing. Clipboard sharing for any previous connection is automatically disabled.

This property can only be used for desktop apps.

This property is valid for the sharer side only.

This property is available starting with Windows 10, version 1511.

 VT_BOOL
"SetClipboardRedirectCallback" Specifies an IUnknown pointer to an instance of IRDPSRAPIClipboardUseEvents that receives a callback each time a copying from the sharer computer to the viewer is attempted. This property is only relevant if clipboard sharing is enabled.

This property becomes read-only after the IRDPSRAPISharingSession::Open method is called. You can set this property only before calling that method.

This property can only be used for desktop apps.

This property is valid for the sharer side only.

This property is available starting with Windows 10, version 1511.

 VT_UNKNOWN
"EnabledTransports" Specifies the transports to enable. A value of 3 supports both TCP and UDP. The default is 1, which is TCP only.

This property becomes read-only after the IRDPSRAPISharingSession::Open method is called. You can set this property only before calling that method.

This property is available starting with Windows 10, version 1803.

This property is valid for the sharer side only.

 VT_I4

Requirements

Requirement Value
Minimum supported client Windows Vista [desktop apps | UWP apps]
Minimum supported server Windows Server 2008 [desktop apps | UWP apps]
Target Platform Windows
Header rdpencomapi.h
DLL RdpEncom.dll

See also

IRDPSRAPISessionProperties