Peer.Invite Method (PeerApplication, String, Byte())

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Sends an invitation to a Peer to start a specific PeerApplication.

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

Public MustOverride Function Invite (
	applicationToInvite As PeerApplication,
	message As String,
	invitationData As Byte()
) As PeerInvitationResponse

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 message can be no more than 255 Unicode characters.

invitationData
Type: System.Byte()

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

Return Value

Type: System.Net.PeerToPeer.Collaboration.PeerInvitationResponse

A PeerInvitationResponse from the peer that received the invitation.

Exception Condition
ArgumentException

The application is not registered for collaboration.

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 peer 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: