Método IX509PrivateKey::Export (certenroll.h)

  • Artículo

El método Export copia la clave privada en una matriz de bytes. La matriz de bytes se representa mediante una cadena con codificación Unicode.

Sintaxis

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

Parámetros

[in] strExportType

Valor BSTR que especifica cómo se exporta la clave privada.

Si la clave se creó mediante un KSP de CNG (proveedor de almacenamiento de claves), puede especificar uno de los valores permitidos por el parámetro pszBlobType en la función NCryptExportKey .

Si la clave se creó mediante un CSP cryptoAPI (proveedor de servicios criptográficos), puede especificar uno de los siguientes valores del archivo de encabezado Bcrypt.h incluido con Wincrypt.h.

Valor Significado
BCRYPT_PUBLIC_KEY_BLOB
 Exporta solo la parte pública de la clave privada.
BCRYPT_PRIVATE_KEY_BLOB
 Exporta toda la clave privada.

[in] Encoding

Valor de enumeración EncodingType que especifica el tipo de codificación Unicode que se va a aplicar a la cadena contenida en el parámetro pstrEncodedKey . El valor predeterminado es XCN_CRYPT_STRING_BASE64.

[out] pstrEncodedKey

Puntero a una variable BSTR que contiene la clave privada.

Valor devuelto

Si la función se realiza correctamente, la función devuelve S_OK.

Si se produce un error en la función, devuelve un valor HRESULT que indica el error. Entre los valores posibles se incluyen los que se indican en la tabla siguiente, entre otros. Para obtener una lista de códigos de error comunes, consulte Valores HRESULT comunes.

Código devuelto Descripción
HRESULT_FROM_WIN32(ERROR_CALL_NOT_IMPLEMENTED)
 La clave se creó mediante un CSP de CryptoAPI y especificó un valor distinto de BCRYPT_PRIVATE_KEY_BLOB o BCRYPT_PUBLIC_KEY_BLOB para el parámetro strExportType .

Requisitos

   
Cliente mínimo compatible Windows Vista [solo aplicaciones de escritorio]
Servidor mínimo compatible Windows Server 2008 [solo aplicaciones de escritorio]
Plataforma de destino Windows
Encabezado certenroll.h
Archivo DLL CertEnroll.dll

Consulte también

IX509PrivateKey