PeerCollaboration.SignOut(PeerScope) Method
Definition
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 out of the specified scope.
public:
static void SignOut(System::Net::PeerToPeer::Collaboration::PeerScope peerScope);[System.Security.SecurityCritical]
public static void SignOut (System.Net.PeerToPeer.Collaboration.PeerScope peerScope);[<System.Security.SecurityCritical>]
static member SignOut : System.Net.PeerToPeer.Collaboration.PeerScope -> unitPublic Shared Sub SignOut (peerScope As PeerScope)Parameters
- Attributes
Exceptions
The peerScope parameter contains an invalid enumeration value.
The SignOut(PeerScope) operation could not be completed.
Remarks
This method is not an application-specific operation and signing out may affect other applications that may be currently running. If the user is not already signed into the specified scope calling this method results in a no-op.
When a user signs out of People Near Me, their published information is deleted from the PeerCollaboration endpoint object set. This includes LocalEndPointName and LocalPresenceInfo, in addition to any identifying objects registered by the calling peer into the collaboration infrastructure. Because this information is deleted, it is no longer available to either remote peers or a peer host for collaboration. From the perspective of the PeerCollaboration class, other sharing of the same information with trusted contacts is not relevant; use of the PeerCollaboration class does not affect other objects in which this information was persisted, such as a remote peer ContactManager object. Likewise, deleting a peer from the ContactManager does not affect its presence in a collaboration application; other contacts are still able to view its presence and collaborate with it.
Calling this method requires a PermissionState of Unrestricted. This state is created when the Peer collaboration session begins.
