IRDPSRAPISessionProperties::Property property

Sets or gets a named session property.

This property is read/write.


HRESULT put_Property(
  [in]  BSTR PropertyName,
  [in]  VARIANT newVal

HRESULT get_Property(
  [in]  BSTR PropertyName,
  [out] VARIANT *pVal

Property value

The current value of the property.

Error codes

If the method succeeds, the return value is S_OK. Otherwise, the return value is an error code.


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

Property nameProperty descriptionValue type


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.



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.



Specifies the protocol family to start the listener on sharer. The possible values are as follows:


Value: 0

The address family is unspecified.


Value: 2

The Internet Protocol version 4 (IPv4) address family.


Value: 23

The Internet Protocol version 6 (IPv6) address family.



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.




Minimum supported client

Windows Vista [desktop apps | Windows Store apps]

Minimum supported server

Windows Server 2008 [desktop apps | Windows Store apps]





Type library




See also