Edit

Share via

IX509PrivateKey::Import method (certenroll.h)

  • Article

The Import method imports an existing private key into a key container within a cryptographic provider.

Syntax

HRESULT Import(
  [in] BSTR         strExportType,
  [in] BSTR         strEncodedKey,
  [in] EncodingType Encoding
);

Parameters

[in] strExportType

If the key was created by using a CNG KSP (Key Storage Provider), the Import method passes this argument to the pszProperty parameter of the NCryptSetProperty function. That is, the value you specify will be used as the name of a property to be set on the imported key.

If the key was created by using a CryptoAPI CSP (Cryptographic Service Provider), this argument specifies how the private key is to be imported. This can be the following value.

Value Meaning
BCRYPT_PRIVATE_KEY_BLOB
 Imports the entire private key.

[in] strEncodedKey

A BSTR variable that contains the key to import.

[in] Encoding

An EncodingType enumeration value that specifies the type of Unicode encoding to be applied to the string contained in the strEncodedKey parameter. The default value is XCN_CRYPT_STRING_BASE64.

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 Description
HRESULT_FROM_WIN32(ERROR_FILE_READ_ONLY)
 The key container is already open. You can receive this error if you have already called Open or Create.
HRESULT_FROM_WIN32(ERROR_CALL_NOT_IMPLEMENTED)
 The key was created by a CryptoAPI CSP and you specified a value other than BCRYPT_PRIVATE_KEY_BLOB for the strExportType parameter.

Remarks

The Import function automatically assumes that you are attempting to import a CNG KSP key if you specify a value other than BCRYPT_PRIVATE_KEY_BLOB for the strExportType parameter and you do not set any of the following properties:

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

IX509PrivateKey