IRDPSRAPIViewer interface (rdpencomapi.h)
[The IRDPSRAPIViewer interface is no longer available for use for UWP applications as of Windows 10, version 1709. It is still supported for Desktop Apps.]
The ActiveX interface that is used on the viewer side. The IRDPSRAPIViewer interface is equivalent to the IRDPSRAPISharingSession interface on the sharer side.
This interface can be used to connect or disconnect viewers and to get or set various properties on the viewer ActiveX control.
Inheritance
The IRDPSRAPIViewer interface inherits from the IDispatch interface. IRDPSRAPIViewer also has these types of members:
Methods
The IRDPSRAPIViewer interface has these methods.
| IRDPSRAPIViewer::Connect Starts the actual connection to the sharer. |
| IRDPSRAPIViewer::Disconnect Initiates a disconnect of the viewer from the sharer. |
| IRDPSRAPIViewer::get_ApplicationFilter Returns an object implementing the IRDPSRAPIApplicationFilter interface. (IRDPSRAPIViewer.get_ApplicationFilter) |
| IRDPSRAPIViewer::get_Attendees Returns an object implementing the IRDPSRAPIAttendeeManager interface. (IRDPSRAPIViewer.get_Attendees) |
| IRDPSRAPIViewer::get_DisconnectedText Retrieves or sets the text that appears centered in the control before a connection is terminated. (Get) |
| IRDPSRAPIViewer::get_Invitations Returns an object implementing the IRDPSRAPIInvitationManager interface. (IRDPSRAPIViewer.get_Invitations) |
| IRDPSRAPIViewer::get_Properties Returns an object implementing the IRDPSRAPISessionProperties interface. |
| IRDPSRAPIViewer::get_SmartSizing Gets or sets the smart sizing property of the viewer ActiveX control. (Get) |
| IRDPSRAPIViewer::get_VirtualChannelManager Returns an object implementing the IRDPSRAPIVirtualChannelManager interface. |
| IRDPSRAPIViewer::put_DisconnectedText Retrieves or sets the text that appears centered in the control before a connection is terminated. (Put) |
| IRDPSRAPIViewer::put_SmartSizing Gets or sets the smart sizing property of the viewer ActiveX control. (Put) |
| IRDPSRAPIViewer::RequestColorDepthChange Requests a color depth change on the sharer Winlogon user session. |
| IRDPSRAPIViewer::RequestControl Requests the sharer to change the control level of the viewer. |
| IRDPSRAPIViewer::StartReverseConnectListener Initiates a listener for accepting reverse connections from the sharer to the viewer, or obtains the connection string that the sharer uses to reverse connect to the viewer. |
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client | Windows Vista [desktop apps only] |
| Minimum supported server | Windows Server 2008 [desktop apps only] |
| 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