PeerIdentityExport function (p2p.h)

The PeerIdentityExport function allows a user to export one peer identity. The user can then transfer the peer identity to a different computer.

Syntax

NOT_BUILD_WINDOWS_DEPRECATE HRESULT PeerIdentityExport(
  [in]  PCWSTR pwzIdentity,
  [in]  PCWSTR pwzPassword,
  [out] PWSTR  *ppwzExportXML
);

Parameters

[in] pwzIdentity

Specifies the peer identity to export. This parameter is required and does not have a default value.

[in] pwzPassword

Specifies the password to use to encrypt the peer identity. This parameter cannot be NULL. This password must also be used to import the peer identity, or the import operation fails.

[out] ppwzExportXML

Receives a pointer to the exported peer identity in XML format. If the export operation is successful, the application must free ppwzExportXML by calling PeerFreeData.

Return value

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

Remarks

Peer-to-peer group membership credentials are not exported. Only one peer identity is exported. An exported peer identity can be imported on another computer by using PeerIdentityImport.

Exporting a peer identity does not remove it from a local ccmputer, it makes a copy of it. The copy can be used to backup and restore a peer identity.

The XML fragment used by PeerIdentityExport is as follows:

<PEERIDENTITYEXPORT VERSION="1.0">
   <PEERNAME>
     <!-- UTF-8 encoded peer name of the identity -->
   </PEERNAME>
   <DATA xmlns:dt="urn:schemas-microsoft-com:datatypes" dt:dt="bin.base64">
      <!-- base64 encoded / PFX encoded and encrypted IDC with the private key -->
   </DATA>
</PEERIDENTITYEXPORT>

Requirements

See also

PEER_DATA

PeerFreeData

PeerIdentityImport