PeerCollaboration.SignIn(PeerScope) Method

Reference

Definition

Namespace:: System.Net.PeerToPeer.Collaboration

Assembly:: System.Net.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Signs the peer into the collaboration infrastructure with the specified PeerScope.

public:
 static void SignIn(System::Net::PeerToPeer::Collaboration::PeerScope peerScope);

[System.Security.SecurityCritical]
public static void SignIn (System.Net.PeerToPeer.Collaboration.PeerScope peerScope);

[<System.Security.SecurityCritical>]
static member SignIn : System.Net.PeerToPeer.Collaboration.PeerScope -> unit

Public Shared Sub SignIn (peerScope As PeerScope)

Parameters

peerScope: PeerScope

The scope the peer is using to join the PeerCollaboration activity.

Attributes: SecurityCriticalAttribute

Exceptions

ArgumentException

peerScope is set to None.

ArgumentOutOfRangeException

The peerScope parameter contains an invalid enumeration value.

PeerToPeerException

The SignIn(PeerScope) operation could not be completed.

Examples

The following code example illustrates how to sign the users into the Collaboration infrastructure.

//This function signs the users into the Collaboration Infrastructure.
public static bool PeerCollabSignin()
{
    bool result = false;
    try
    {
        PeerCollaboration.SignIn(PeerScope.All);
        result = true;
    }
    catch(Exception ex)
    {
        Console.WriteLine("Error signing in: {0}", ex.Message);
    }
    return result;
}

Remarks

Display names are not necessarily unique. Users should verify the identity of the person using the display name by email, phone, or in person before accepting a collaboration invitation.

This function signs the users into the Collaboration Infrastructure.

Access to this method requires a PermissionState of Unrestricted. This state is created when the Peer collaboration session begins.

Applies to