ICertPropertyArchivedKeyHash::Initialize method (certenroll.h)

The Initialize method initializes the object from a byte array that contains the hash. The byte array is represented as a Unicode-encoded string.

Syntax

HRESULT Initialize(
  [in] EncodingType Encoding,
  [in] BSTR         strArchivedKeyHashValue
);

Parameters

[in] Encoding

An EncodingType enumeration value that specifies the type of Unicode encoding applied to the input string.

[in] strArchivedKeyHashValue

A BSTR variable that contains a SHA-1 hash of the encrypted private key.

Return value

If the function succeeds, the function returns S_OK.

If the function fails, it returns an HRESULT value that indicates the error. Possible values include, but are not limited to, those in the following table. For a list of common error codes, see Common HRESULT Values.

Return code/value Description
HRESULT_FROM_WIN32(ERROR_ALREADY_INITIALIZED)
The object is already initialized.

Remarks

Call the SetValueOnCertificate method to associate the property with a certificate. Call the ArchivedKeyHash property to retrieve the hash.

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

ArchivePrivateKey

ICertPropertyArchivedKeyHash

KeyArchivalCertificate