Edit

Share via

ISignerCertificate::Initialize method (certenroll.h)

  • Article

The Initialize method initializes the object from a signing certificate.

Syntax

HRESULT Initialize(
  [in] VARIANT_BOOL         MachineContext,
  [in] X509PrivateKeyVerify VerifyType,
  [in] EncodingType         Encoding,
  [in] BSTR                 strCertificate
);

Parameters

[in] MachineContext

A VARIANT_BOOL variable that indicates whether to search the local computer certificate store context or the user context to find the certificate identified by the strCertificate parameter. Specify VARIANT_TRUE for the computer and VARIANT_FALSE for the user.

[in] VerifyType

An X509PrivateKeyVerify enumeration value that specifies whether the private key used to sign the certificate must be verified and, if so, whether the verification must be silent or allows user input.

[in] Encoding

An EncodingType enumeration value that specifies the type of Unicode encoding applied to the Distinguished Encoding Rules (DER) encoded certificate string.

[in] strCertificate

A BSTR variable that contains the DER-encoded certificate.

Beginning with Windows 7 and Windows Server 2008 R2, you can specify a certificate thumb print or serial number rather than an encoded certificate. Doing so causes the function to search the appropriate local stores for the matching certificate. Keep in mind the following points:

  • The BSTR must be an even number of hexadecimal digits.
  • Whitespace between hexadecimal pairs is ignored.
  • The Encoding parameter must be set to XCN_CRYPT_STRING_HEXRAW.
  • The MachineContext parameter determines whether the user or computer stores or both are searched.
  • If a private key is needed, only the personal and request stores are searched.
  • If a private key is not needed, the root and intermediate CA stores are also searched.

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 ISignerCertificate object has already been initialized.

Remarks

The Initialize method:

Set the following properties before calling Initialize:

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

ISignerCertificate