PeerCollabGetApplicationRegistrationInfo function (p2p.h)

The PeerCollabGetApplicationRegistrationInfo function obtains application-specific registration information.

Syntax

NOT_BUILD_WINDOWS_DEPRECATE HRESULT PeerCollabGetApplicationRegistrationInfo(
  [in]  const GUID                          *pApplicationId,
  [in]  PEER_APPLICATION_REGISTRATION_TYPE  registrationType,
  [out] PPEER_APPLICATION_REGISTRATION_INFO *ppApplication
);

Parameters

[in] pApplicationId

Pointer to the GUID value that represents a particular peer's application registration flags.

[in] registrationType

A PEER_APPLICATION_REGISTRATION_TYPE enumeration value that describes whether the peer's application is registered to the current user or all users of the local machine.

[out] ppApplication

Pointer to the address of a PEER_APPLICATION_REGISTRATION_INFO structure that contains the information about a peer's specific registered application. The data returned in this parameter can be freed by calling PeerFreeData.

Return value

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

Remarks

An application is a set of software or software features available on the peer's endpoint. Commonly, this refers to software packages that support peer networking activities, like games or other collaborative applications.

A peer's application has a GUID representing a single application. When an application is registered for a peer, this GUID and the corresponding application can be made available to all trusted contacts of the peer, indicating the activities the peer can participate in. To unregister a peer's application, call PeerCollabUnregisterApplication with this GUID.

Requirements

See also

PEER_APPLICATION_REGISTRATION_INFO

PEER_APPLICATION_REGISTRATION_TYPE

Peer Collaboration API Functions

PeerCollabRegisterApplication

PeerCollabUnregisterApplication