Export (0) Print
Expand All

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

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

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

public abstract PeerInvitationResponse Invite(
	PeerApplication applicationToInvite,
	string message,
	byte[] invitationData
)

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.

ExceptionCondition
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

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Show:
© 2014 Microsoft