IRDPSRAPIInvitationManager::CreateInvitation method

Creates an invitation.

Syntax


HRESULT CreateInvitation(
  [in]  BSTR                bstrAuthString,
  [in]  BSTR                bstrGroupName,
  [in]  BSTR                bstrPassword,
  [in]  long                AttendeeLimit,
  [out] IRDPSRAPIInvitation **ppInvitation
);

Parameters

bstrAuthString [in]

Type: BSTR

String to use for the authorization. The string is limited to 255 characters and must be unique for the session. If NULL, the method generates the string for you.

bstrGroupName [in]

Type: BSTR

The name of the group. The string must be unique for the session. Applications typically use the group name to separate attendees into groups that can be granted different authorization levels.

bstrPassword [in]

Type: BSTR

Password to use for authentication. The password is limited to 255 characters. You must provide the password to the viewer out-of-band from the ticket.

AttendeeLimit [in]

Type: long

The maximum number of attendees.

ppInvitation [out]

Type: IRDPSRAPIInvitation**

An IRDPSRAPIInvitation interface pointer.

Return value

Type: HRESULT

If the method succeeds, the return value is S_OK. Otherwise, the return value is an error code.

Requirements

Minimum supported client

Windows Vista [desktop apps | UWP apps]

Minimum supported server

Windows Server 2008 [desktop apps | UWP apps]

Header

RdpEncomAPI.h

IDL

RdpEncomAPI.idl

Type library

RdpEncomAPI.tlb

DLL

RdpEncom.dll

See also

IRDPSRAPIInvitationManager

 

 

Show: