PeerCollabUpdateContact function (p2p.h)

The PeerCollabUpdateContact function updates the information associated with a peer contact specified in the local contact store of the caller.

Syntax

NOT_BUILD_WINDOWS_DEPRECATE HRESULT PeerCollabUpdateContact(
  [in] PCPEER_CONTACT pContact
);

Parameters

[in] pContact

Pointer to a PEER_CONTACT structure that contains the updated information for a specific peer contact.

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

If the contact provided is the 'Me' contact, only the nickname, display name and email address can be changed. If a nickname is changed for a contact signed in to "People Near Me", the structure PEER_EVENT_PEOPLE_NEAR_ME_CHANGED_DATA with changeType of PEER_CHANGE_UPDATED will be raised.

The PeerCollabUpdateContact function will timeout at 30 seconds.

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 Collaboration API Functions