_IRDPSessionEvents interface (rdpencomapi.h)

Implement this interface to receive notifications when events occur.

Inheritance

The _IRDPSessionEvents interface inherits from the IDispatch interface.

Remarks

The RDPViewer COM object is a connectable object. To receive events from the object about the connection sharing session, an application can implement _IRdpSessionEvents and perform the following steps.

1. Call IUnknown::QueryInterface on the RDPViewer to obtain a pointer to the IConnectionPointContainer interface.
2. Call IConnectionPointContainer::FindConnectionPoint, specifying __uuidof(_IRdpSessionEvents) as the riid parameter, to obtain a pointer to the IConnectionPoint interface of the client control events.
3. Call IConnectionPoint::Advise to specify the calling application's own implementation of _IRdpSessionEvents where the events are to be dispatched.

Application can use the following DISPIDs when implementing IDispatch::Invoke.

dispIdMember	Dispatch to method
DISPID_RDPSRAPI_EVENT_ON_ATTENDEE_CONNECTED = 301	OnAttendeeConnected
DISPID_RDPSRAPI_EVENT_ON_ATTENDEE_DISCONNECTED = 302	OnAttendeeDisconnected
DISPID_RDPSRAPI_EVENT_ON_ATTENDEE_UPDATE = 303	OnAttendeeUpdate
DISPID_RDPSRAPI_EVENT_ON_ERROR = 304	OnError
DISPID_RDPSRAPI_EVENT_ON_APPLICATION_OPEN = 316	OnApplicationOpen
DISPID_RDPSRAPI_EVENT_ON_APPLICATION_CLOSE = 317	OnApplicationClose
DISPID_RDPSRAPI_EVENT_ON_APPLICATION_UPDATE = 318	OnApplicationUpdate
DISPID_RDPSRAPI_EVENT_ON_WINDOW_OPEN = 319	OnWindowOpen
DISPID_RDPSRAPI_EVENT_ON_WINDOW_CLOSE = 320		OnWindowClose
DISPID_RDPSRAPI_EVENT_ON_WINDOW_UPDATE = 321	OnWindowUpdate
DISPID_RDPSRAPI_EVENT_ON_CTRLLEVEL_CHANGE_REQUEST = 309	OnControlLevelChangeRequest
DISPID_RDPSRAPI_EVENT_ON_VIEWER_CONNECTED = 305	OnConnectionEstablished
DISPID_RDPSRAPI_EVENT_ON_VIEWER_CONNECTFAILED = 308	OnConnectionFailed
DISPID_RDPSRAPI_EVENT_ON_VIEWER_AUTHENTICATED = 307	OnConnectionAuthenticated
DISPID_RDPSRAPI_EVENT_ON_VIEWER_DISCONNECTED = 306	OnConnectionTerminated
DISPID_RDPSRAPI_EVENT_ON_APPFILTER_UPDATE = 322	None. A notification that the application filter returned by IRDPSRAPISharingSession::get_ApplicationFilter has changed.
DISPID_RDPSRAPI_EVENT_ON_GRAPHICS_STREAM_PAUSED = 310	OnGraphicsStreamPaused
DISPID_RDPSRAPI_EVENT_ON_GRAPHICS_STREAM_RESUMED = 311	OnGraphicsStreamResumed
DISPID_RDPSRAPI_EVENT_ON_VIRTUAL_CHANNEL_DATARECEIVED = 314	OnChannelDataReceived
DISPID_RDPSRAPI_EVENT_ON_VIRTUAL_CHANNEL_SENDCOMPLETED = 315	OnChannelDataSent
DISPID_RDPSRAPI_EVENT_ON_SHARED_RECT_CHANGED = 323	OnSharedRectChanged
DISPID_RDPSRAPI_EVENT_ON_FOCUSRELEASED = 324	OnFocusReleased
DISPID_RDPSRAPI_EVENT_ON_SHARED_DESKTOP_SETTINGS_CHANGED = 325	OnSharedDesktopSettingsChanged
DISPID_RDPAPI_EVENT_ON_BOUNDING_RECT_CHANGED = 340	OnViewingSizeChanged

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

IDispatch