PeerGroupExportConfig function (p2p.h)

The PeerGroupExportConfig function exports the group configuration for a peer as an XML string that contains the identity, group name, and the GMC for the identity.

Syntax

NOT_BUILD_WINDOWS_DEPRECATE HRESULT PeerGroupExportConfig(
  [in]  HGROUP hGroup,
  [in]  PCWSTR pwzPassword,
  [out] PWSTR  *ppwzXML
);

Parameters

[in] hGroup

Handle to the group. This handle is returned by the PeerGroupCreate, PeerGroupOpen, or PeerGroupJoin function. This parameter is required.

[in] pwzPassword

Specifies the password used to protect the exported configuration. There are no rules or limits for the formation of this password. This parameter is required.

[out] ppwzXML

Pointer to the returned XML configuration string that contains the identity, group peer name, cloud peer name, group scope, and the GMC for the identity. This parameter is required.

Return value

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

Cryptography-specific errors can be returned from the Microsoft Base Cryptographic Provider. These errors are prefixed with CRYPT_* and defined in Winerror.h.

Remarks

After being exported, this configuration can be passed out-of-band to another peer, where the configuration of the identity can be established. To import the configuration, pass the XML string returned by this function with the password set on it to PeerGroupImportConfig.

The configuration XML string appears in the following format:

<PEERGROUPCONFIG VERSION="1.0">
  <IDENTITYPEERNAME>
    <!-- UTF-8 encoded peer name of the identity -->
  </IDENTITYPEERNAME>
  <GROUPPEERNAME>
    <!-- UTF-8 encoded peer name of the group -->
  </GROUPPEERNAME>
  <CLOUDNAME>
    <!-- UTF-8 encoded Unicode name of the cloud -->
  </CLOUDNAME>
  <SCOPE>
    <!-- UTF-8 encoded Unicode name of the scope: global, site-local, link-local -->
  </SCOPE>
  <CLOUDFLAGS>
    <!-- A DWORD containing cloud-specific settings, represented as a string -->
  </CLOUDFLAGS>
  <GMC xmlns:dt="urn:schemas-microsoft-com:datatypes" dt:dt="bin.base64">
    <!-- base64/PKCS7 encoded GMC chain -->
  </GMC>
</PEERGROUPCONFIG>

Requirements