PeerCollabDeleteEndpointData function (p2p.h)

The PeerCollabDeleteEndpointData function deletes the peer endpoint data on the calling peer node that matches the supplied endpoint data.

Syntax

NOT_BUILD_WINDOWS_DEPRECATE HRESULT PeerCollabDeleteEndpointData(
  [in] PCPEER_ENDPOINT pcEndpoint
);

Parameters

[in] pcEndpoint

Pointer to a PEER_ENDPOINT structure that contains the peer endpoint information to delete from the current peer node.

Return value

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.

Remarks

The function PeerCollabDeleteEndpointData is used to remove cached endpoint data previously retrieved by PeerCollabRefreshEndpointData when it is no longer required. Any data obtained through PeerCollabRefreshEndpointData remains in memory until PeerCollabDeleteEndpointData is called.

Requirements

Requirement Value
Minimum supported client Windows Vista [desktop apps only]
Minimum supported server None supported
Target Platform Windows
Header p2p.h
Library P2P.lib
DLL P2P.dll

See also

PEER_ENDPOINT

Peer Collaboration API Functions

PeerCollabRefreshEndpointData