IRDPSRAPIInvitation interface
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.
Members
The IRDPSRAPIInvitation interface inherits from the IDispatch interface. IRDPSRAPIInvitation also has these types of members:
Properties
The IRDPSRAPIInvitation interface has these properties.
| Property | Access type | Description |
|---|---|---|
|
Read/write |
The maximum number of attendees that can connect to the session. | |
|
Read-only |
The ticket string. | |
|
Read-only |
The group name. | |
|
Read-only |
The password string. | |
|
Read/write |
The revoked state of the invitation. |
Requirements
|
Minimum supported client |
Windows Vista [desktop apps | Windows Store apps] |
|---|---|
|
Minimum supported server |
Windows Server 2008 [desktop apps | Windows Store apps] |
|
Header |
|
|
IDL |
|
|
Type library |
|
|
DLL |
|
|
CLSID |
CLSID_RDPSRAPIInvitation is defined as 49174dc6-0731-4b5e-8ee1-83a63d3868fa |
|
IID |
IID_IRDPSRAPIInvitation is defined as 4fac1d43-fc51-45bb-b1b4-2b53aa562fa3 |
See also