IX509CertificateRequestCmc::put_ArchivePrivateKey method (certenroll.h)

The ArchivePrivateKey property specifies or retrieves a Boolean value that indicates whether to archive a private key on the certification authority (CA).

This property is read/write.

Syntax

HRESULT put_ArchivePrivateKey(
  VARIANT_BOOL Value
);

Parameters

Value

Return value

None

Remarks

To request that a CA archive your private key, you must also set the KeyArchivalCertificate property with the CA encryption (key exchange) certificate.

You can set this property before calling the Encode method, but you must initialize the CMC request object before setting the property value. For more information, see the following topics:

Requirements

Requirement Value
Minimum supported client Windows Vista [desktop apps only]
Minimum supported server Windows Server 2008 [desktop apps only]
Target Platform Windows
Header certenroll.h
DLL CertEnroll.dll

See also

IX509CertificateRequestCmc