Метод IX509PrivateKey::Export (certenroll.h)

Статья
08/22/2023

Метод Export копирует закрытый ключ в массив байтов. Массив байтов представлен строкой в кодировке Юникод.

Синтаксис

HRESULT Export(
  [in]  BSTR         strExportType,
  [in]  EncodingType Encoding,
  [out] BSTR         *pstrEncodedKey
);

Параметры

[in] strExportType

Значение BSTR , указывающее, как экспортируется закрытый ключ.

Если ключ был создан с помощью CNG KSP (поставщика хранилища ключей), можно указать одно из значений, разрешенных параметром pszBlobType в функции NCryptExportKey .

Если ключ был создан с помощью CSP CryptoAPI (поставщика служб шифрования), можно указать одно из следующих значений в файле заголовка Bcrypt.h, включенном в Wincrypt.h.

Значение	Значение
BCRYPT_PUBLIC_KEY_BLOB	Экспортирует только открытую часть закрытого ключа.
BCRYPT_PRIVATE_KEY_BLOB	Экспортирует весь закрытый ключ.

[in] Encoding

Значение перечисления EncodingType , указывающее тип кодировки Юникода, применяемой к строке, содержащейся в параметре pstrEncodedKey . Значение по умолчанию — XCN_CRYPT_STRING_BASE64.

[out] pstrEncodedKey

Указатель на переменную BSTR , содержащую закрытый ключ.

Возвращаемое значение

Если функция выполнена успешно, функция возвращает S_OK.

Если функция завершается сбоем, она возвращает значение HRESULT , указывающее на ошибку. Допустимые значения включают, но не ограничиваются, значения, приведенные в следующей таблице. Список распространенных кодов ошибок см. в разделе Общие значения HRESULT.

Код возврата	Описание
HRESULT_FROM_WIN32(ERROR_CALL_NOT_IMPLEMENTED)	Ключ был создан поставщиком CSP CryptoAPI, и вы указали значение, отличное от BCRYPT_PRIVATE_KEY_BLOB или BCRYPT_PUBLIC_KEY_BLOB для параметра strExportType .

Требования


Минимальная версия клиента	Windows Vista [только классические приложения]
Минимальная версия сервера	Windows Server 2008 [только классические приложения]
Целевая платформа	Windows
Header	certenroll.h
DLL	CertEnroll.dll

См. также раздел

IX509PrivateKey

Поделиться через