IRDPSRAPIInvitation interface (rdpencomapi.h)
Invitations enable a person or group of persons to connect to a session. When an attendee connects to a session, the client sends a ticket and a password. These two pieces of information are used to authenticate an attendee.
Applications obtain access to this object using IRDPSRAPIInvitationManager::CreateInvitation.
An attendee can join a session if the invitation list contains and invitation with the following properties:
- The ticket string in ConnectionString matches the one sent by the client.
- The password string in Password matches the one sent by the client.
- The number of attendees has not exceeded the maximum number in AttendeeLimit.
- The invitation has not been revoked using Revoked.
Inheritance
The IRDPSRAPIInvitation interface inherits from the IDispatch interface.
Methods
The IRDPSRAPIInvitation interface has these methods.
| IRDPSRAPIInvitation::get_AttendeeLimit The maximum number of attendees that can connect to the session. (Get) |
| IRDPSRAPIInvitation::get_ConnectionString The ticket string. |
| IRDPSRAPIInvitation::get_GroupName The group name. |
| IRDPSRAPIInvitation::get_Password The password string. |
| IRDPSRAPIInvitation::get_Revoked The revoked state of the invitation. (Get) |
| IRDPSRAPIInvitation::put_AttendeeLimit The maximum number of attendees that can connect to the session. (Put) |
| IRDPSRAPIInvitation::put_Revoked The revoked state of the invitation. (Put) |
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