Skip to content

Latest commit

 

History

History
122 lines (98 loc) · 3.39 KB

nf-p2p-peercollabsignout.md

File metadata and controls

122 lines (98 loc) · 3.39 KB
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NF:p2p.PeerCollabSignout
PeerCollabSignout function (p2p.h)
Signs a peer out of a specific type of peer collaboration network presence provider.
PeerCollabSignout
PeerCollabSignout function [Peer Networking]
p2p.peercollabsignout
p2p/PeerCollabSignout
p2p\peercollabsignout.htm
p2p
aa69a233-6104-47c6-a0b5-378794108623
12/05/2018
PeerCollabSignout, PeerCollabSignout function [Peer Networking], p2p.peercollabsignout, p2p/PeerCollabSignout
p2p.h
Windows
Windows Vista [desktop apps only]
None supported
P2P.lib
P2P.dll
Windows
19H1
PeerCollabSignout
p2p/PeerCollabSignout
c++
APIRef
kbSyntax
DllExport
P2P.dll
PeerCollabSignout

PeerCollabSignout function

-description

The PeerCollabSignout function signs a peer out of a specific type of peer collaboration network presence provider.

-parameters

-param dwSigninOptions [in]

PEER_SIGNIN_FLAGS enumeration value that contains the presence provider sign-in options for the calling peer. This value is obtained by calling PeerCollabGetSigninOptions from the peer application.

-returns

Returns S_OK if the function succeeds. Otherwise, the function returns one of the following values.

Return code Description
E_OUTOFMEMORY
There is not enough memory to support this operation.
E_INVALIDARG
One of the arguments is invalid.
PEER_E_NOT_INITIALIZED
The application did not make a previous call to PeerCollabStartup.

-remarks

If the local peer's collaboration infrastructure is signed out of both Internet and People Near Me presence, all transient information like objects and the endpoint ID are deleted. Any application that uses this information must republish the information. A single event that indicates signout is raised, instead of sending multiple individual events for each object or application.

Multiple applications can use the infrastructure at any given moment. It is not recommended for a single application to sign out, as other applications will not be able to use the infrastructure. Applications must also be prepared to handle user sign in and sign out, or situations where a machine goes to sleep or into hibernation.

-see-also

PEER_SIGNIN_FLAGS

Peer Collaboration API Functions

PeerCollabGetSigninOptions