IRDPSRAPISharingSession interface (rdpencomapi.h)
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.
Inheritance
The IRDPSRAPISharingSession interface inherits from the IDispatch interface. IRDPSRAPISharingSession also has these types of members:
Methods
The IRDPSRAPISharingSession interface has these methods.
| IRDPSRAPISharingSession::Close Disconnects all attendees from the session and stops listening to incoming connections. |
| IRDPSRAPISharingSession::ConnectToClient Used for reverse connect mode, where the sharer connects to the viewer. |
| IRDPSRAPISharingSession::get_ApplicationFilter Returns an object implementing the IRDPSRAPIApplicationFilter interface. (IRDPSRAPISharingSession.get_ApplicationFilter) |
| IRDPSRAPISharingSession::get_Attendees Returns an object implementing the IRDPSRAPIAttendeeManager interface. (IRDPSRAPISharingSession.get_Attendees) |
| IRDPSRAPISharingSession::get_ColorDepth Retrieves or sets the color depth for the shared session. (Get) |
| IRDPSRAPISharingSession::get_Invitations Returns an object implementing the IRDPSRAPIInvitationManager interface. (IRDPSRAPISharingSession.get_Invitations) |
| IRDPSRAPISharingSession::get_Properties Retrieves an object implementing the IRDPSRAPISessionProperties interface. |
| IRDPSRAPISharingSession::get_VirtualChannelManager Retrieves an object implementing the IRDPSRAPIVirtualChannelManager interface. |
| IRDPSRAPISharingSession::GetDesktopSharedRect Retrieves the current desktop region being shared. |
| IRDPSRAPISharingSession::Open Puts the session in an active state. |
| IRDPSRAPISharingSession::Pause Pauses the graphics stream that is sent to all viewers from the sharer until IRDPSRAPISharingSession::Resume is called. |
| IRDPSRAPISharingSession::put_ColorDepth Retrieves or sets the color depth for the shared session. (Put) |
| IRDPSRAPISharingSession::Resume Causes the graphics stream that is sent to all viewers from the sharer to resume until either IRDPSRAPISharingSession::Pause or IRDPSRAPISharingSession::Close is called. |
| IRDPSRAPISharingSession::SetDesktopSharedRect Sets the desktop region that will be shared. |
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 |
See also
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for