IRDPSRAPISharingSession interface
The main object that an application must create to start a collaboration session. It is also the only object that you can create an instance of. The rest of the objects are accessed as session object properties.
The session object is hosted in-process by RdpEncom.dll. Even if the object is hosted in-process, there can be only one instance of this object created within a Winlogon session. Creating a second object will fail.
This interface uses the single-threaded apartment (STA) threading model. The object exposes a source interface that is used for firing session-specific events (_IRDPSessionEvents) and a dual interface that is used for managing a session.
Members
The IRDPSRAPISharingSession interface inherits from the IDispatch interface. IRDPSRAPISharingSession also has these types of members:
Methods
The IRDPSRAPISharingSession interface has these methods.
| Method | Description |
|---|---|
| Close |
Puts the session in an inactive state, closes all attendees, and stops listening to new incoming connections. |
| ConnectToClient |
Connects the viewer from the sharer in reverse connect mode if the viewer cannot connect to the sharer because of a network issue. For example, the viewer may not be able to connect to the sharer because of network address translation (NAT). |
| GetDesktopSharedRect |
Retrieves the rectangle of the sharer's virtual desktop. |
| Open |
Puts the session in an active state and starts listening to incoming connections. |
| Pause |
Pauses the encoding of the sharer's desktop to pause sending graphics updates to all viewers. |
| Resume |
Resumes the encoding of the sharer's desktop to resume sending graphics updates to all viewers. |
| SetDesktopSharedRect |
Sets the rectangle of the sharer's virtual desktop to be shared. |
Properties
The IRDPSRAPISharingSession interface has these properties.
| Property | Access type | Description |
|---|---|---|
|
Read-only |
An object implementing the IRDPSRAPIApplicationFilter interface. | |
|
Read-only |
An object implementing the IRDPSRAPIAttendeeManager interface. | |
|
Read/write |
The color depth of the session. | |
|
Read-only |
An object implementing the IRDPSRAPIInvitationManager interface. | |
|
Read-only |
An object implementing the IRDPSRAPISessionProperties interface. | |
|
Read-only |
An object implementing the IRDPSRAPIVirtualChannelManager interface. |
Requirements
|
Minimum supported client |
Windows Vista [desktop apps | Windows Store apps] |
|---|---|
|
Minimum supported server |
Windows Server 2008 [desktop apps | Windows Store apps] |
|
Header |
|
|
IDL |
|
|
Type library |
|
|
DLL |
|
|
CLSID |
CLSID_RDPSession is defined as 9B78F0E6-3E05-4A5B-B2E8-E743A8956B65 |
|
IID |
IID_IRDPSRAPISharingSession is defined as eeb20886-e470-4cf6-842b-2739c0ec5cfb |
See also