PeerCollabGetApplicationRegistrationInfo function

The PeerCollabGetApplicationRegistrationInfo function obtains application-specific registration information.

Syntax


HRESULT WINAPI PeerCollabGetApplicationRegistrationInfo(
  _In_  const GUID                                *pApplicationId,
  _In_        PEER_APPLICATION_REGISTRATION_TYPE  registrationType,
  _Out_       PPEER_APPLICATION_REGISTRATION_INFO *ppRegInfo
);

Parameters

pApplicationId [in]

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

registrationType [in]

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.

ppRegInfo [out]

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.

Return codeDescription
E_OUTOFMEMORY

There is not enough memory to support this operation.

E_INVALIDARG

One of the arguments is invalid.

PEER_E_NOT_FOUND

The requested application is not registered for the given registrationType.

 

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

Minimum supported client

Windows Vista [desktop apps only]

Minimum supported server

None supported

Header

P2P.h

Library

P2P.lib

DLL

P2P.dll

See also

PEER_APPLICATION_REGISTRATION_INFO
PEER_APPLICATION_REGISTRATION_TYPE
PeerCollabRegisterApplication
PeerCollabUnregisterApplication
Peer Collaboration API Functions

 

 

Community Additions

ADD
Show: