PeerGroupImportConfig function

The PeerGroupImportConfig function imports a peer group configuration for an identity based on the specific settings in a supplied XML configuration string.

Syntax

HRESULT WINAPI PeerGroupImportConfig(
  _In_   PCWSTR pwzXML,
  _In_   PCWSTR pwzPassword,
  _In_   BOOL fOverwrite,
  _Out_  PWSTR *ppwzIdentity,
  _Out_  PWSTR *ppwzGroup
);

Parameters

pwzXML [in]

Specifies a Unicode string that contains a previously exported (using PeerGroupExportConfig) peer group configuration. For the specific XML format of the string, see to the Remarks section of this topic. This parameter is required.

pwzPassword [in]

Specifies the password used to access the encrypted peer group configuration data, as a Unicode string. This parameter is required.

fOverwrite [in]

If true, the existing group configuration is overwritten. If false, the group configuration is written only if a previous group configuration does not exist. The default value is false. This parameter is required.

ppwzIdentity [out]

Contains the peer identity returned after an import completes. This parameter is required.

ppwzGroup [out]

Contains a peer group peer name returned after an import completes. 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 RSA Base Provider. These errors are prefixed with CRYPT_* and defined in Winerror.h.

Remarks

To generate a peer group configuration, call PeerGroupExportConfig, pass in an identity to export, a password, and a handle to the peer group.

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 peer 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 that contains 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

Send comments about this topic to Microsoft

Build date: 10/26/2012