InviteAsync Method (PeerApplication, String, Byte[], Object)
Collapse the table of content
Expand the table of content

Peer::InviteAsync Method (PeerApplication^, String^, array<Byte>^, Object^)

 

Begins an asynchronous invitation operation which sends an invitation to a Peer to start a specific PeerApplication.

Namespace:   System.Net.PeerToPeer.Collaboration
Assembly:  System.Net (in System.Net.dll)

public:
virtual void InviteAsync(
	PeerApplication^ applicationToInvite,
	String^ message,
	array<unsigned char>^ invitationData,
	Object^ userToken
) abstract

Parameters

applicationToInvite
Type: System.Net.PeerToPeer.Collaboration::PeerApplication^

The PeerApplication for which the invitation is sent.

message
Type: System::String^

A message to send to the remote peer along with the application invitation. The maximum size of this message is 255 Unicode characters.

invitationData
Type: array<System::Byte>^

A user defined data blob to associate with the invitation. Its size can be no more than 16,384 bytes.

userToken
Type: System::Object^

User-defined object to pass to the callback of the asynchronous operation for identification. This required parameter must be unique across all asynchronous invitation operations in progress.

This method does not return a value.

Exception Condition
ArgumentException

The application is not registered with the collaboration infrastructure.

ArgumentNullException

userToken is null.

ArgumentOutOfRangeException

invitationData is larger than 16,384 bytes.

PeerToPeerException
  • An error occurred during the invitation process.

  • The currently executing application is not registered with the collaboration infrastructure.

Calling this method requires a PermissionState of Unrestricted. This state is created when the peer collaboration session begins.

.NET Framework
Available since 3.5
Return to top
Show:
© 2016 Microsoft