PeerIdentityGetXML function (p2p.h)

Article
02/22/2024

The PeerIdentityGetXML function returns a description of the peer identity, which can then be passed to third parties and used to invite a peer identity into a peer group. This information is returned as an XML fragment.

Syntax

NOT_BUILD_WINDOWS_DEPRECATE HRESULT PeerIdentityGetXML(
  [in]  PCWSTR pwzIdentity,
  [out] PWSTR  *ppwzIdentityXML
);

Parameters

[in] pwzIdentity

Specifies the peer identity to retrieve peer identity information for. When this parameter is passed as NULL, a "default" identity will be generated for the user by the peer infrastructure.

[out] ppwzIdentityXML

Pointer to a pointer to a Unicode string that contains the XML fragment. When ppwzIdentityXML is no longer required, the application is responsible for freeing this string by calling PeerFreeData.

Return value

If the function call succeeds, the return value is S_OK. Otherwise, it returns one of the following values.

Return code	Description
E_HANDLE	The handle to the identity is invalid.
E_INVALIDARG	One of the parameters is not valid.
E_OUTOFMEMORY	There is not enough memory to perform the specified operation.

Remarks

The XML fragment returned has the following structure:

&lt;PEERIDENTITYINFO VERSION="1.0"&gt;
     &lt;IDC xmlns:dt="urn:schemas-microsoft-com:datatypes" dt:dt="bin.base64"&gt;
          Base 64 encoded certificate.
     &lt;/IDC&gt;
&lt;/PEERIDENTITYINFO&gt;

This XML fragment is used when creating an invitation to join a group.

Applications are not allowed to add tags within the PEERIDENTITYINFO tag or modify this XML fragment in any way. Applications are allowed to incorporate this XML fragment into other XML documents, but must strip out all application-specific XML before passing this fragment to the PeerGroupCreateInvitation.

Requirements

Requirement	Value
Minimum supported client	Windows XP with SP2 [desktop apps only],Windows XP with SP1 with the Advanced Networking Pack for Windows XP
Minimum supported server	None supported
Target Platform	Windows
Header	p2p.h
Library	P2P.lib
DLL	P2P.dll