IRDPSRAPIAttendee interface (rdpencomapi.h)
Attendee objects are created as a result of clients connecting to the session and being authenticated. After an attendee object is created, it is automatically added to the attendees list.You cannot create an instance of this object. Applications can get access to attendee objects in the following ways:
- When the IRDPSessionEvents::OnAttendeeConnected event is fired, the parameter is an IDispatch pointer corresponding to the attendee object that was created.
- By accessing the Attendee property of the AttendeeDisconnectInfo object. An IDispatch pointer to this object is fired by the IRDPSessionEvents::OnAttendeeDisconnected event. This is how applications are informed of what attendee was disconnected.
- By calling the get_Item method on the IRDPSRAPIAttendeeManager interface.
- By calling get_Next on the enumerator returned by the IRDPSRAPIAttendeeManager::get__NewEnum method.
Inheritance
The IRDPSRAPIAttendee interface inherits from the IDispatch interface. IRDPSRAPIAttendee also has these types of members:
Methods
The IRDPSRAPIAttendee interface has these methods.
| IRDPSRAPIAttendee::get_ConnectivityInfo Retrieves the connectivity information for the attendee. |
| IRDPSRAPIAttendee::get_ControlLevel The level of control the attendee has over the session. (Get) |
| IRDPSRAPIAttendee::get_Flags Retrieves the attendee specific flags that are defined in the RDPENCOMAPI_ATTENDEE_FLAGS enumeration type. |
| IRDPSRAPIAttendee::get_Id The unique identifier for the attendee. |
| IRDPSRAPIAttendee::get_Invitation The invitation used to grant the attendee access to the conference. |
| IRDPSRAPIAttendee::get_RemoteName The name of the remote client. This is usually the attendee's friendly name. |
| IRDPSRAPIAttendee::put_ControlLevel The level of control the attendee has over the session. (Put) |
| IRDPSRAPIAttendee::TerminateConnection Disconnects the client represented by the attendee. |
Remarks
Applications should not save pointers to attendee objects. The lifetime of the attendee object depends on the lifetime of the RDPSession object. It also depends if the session is still in the opened state and if the client corresponding to the attendee object is still connected to the session. Applications can keep references to attendee objects but calling some methods on it after the client disconnected or after the session is destroyed will return E_UNEXPECTED failures.
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