Функция CryptEncodeObject (wincrypt.h)

Статья
08/27/2023

Функция CryptEncodeObject кодирует структуру типа, указанного значением параметра lpszStructType . Рекомендуется использовать CryptEncodeObjectEx в качестве API, который выполняет ту же функцию со значительными улучшениями производительности.

Синтаксис

BOOL CryptEncodeObject(
  [in]      DWORD      dwCertEncodingType,
  [in]      LPCSTR     lpszStructType,
  [in]      const void *pvStructInfo,
  [out]     BYTE       *pbEncoded,
  [in, out] DWORD      *pcbEncoded
);

Параметры

[in] dwCertEncodingType

Тип используемой кодировки. Всегда допустимо указывать типы кодирования сертификатов и сообщений, объединяя их с побитовой операцией ИЛИ , как показано в следующем примере:

X509_ASN_ENCODING | PKCS_7_ASN_ENCODING

В настоящее время определены следующие типы кодирования:

X509_ASN_ENCODING
PKCS_7_ASN_ENCODING

Примечание Требуется сертификат или тип кодирования сообщения . X509_ASN_ENCODING используется по умолчанию. Если указан этот тип, он используется. В противном случае, если указан тип PKCS7_ASN_ENCODING, он используется.

[in] lpszStructType

Указатель на объект OID, определяющий тип структуры. Если слово высокого порядка параметра lpszStructType равно нулю, слово низкого порядка задает целочисленный идентификатор для типа указанной структуры. В противном случае этот параметр является длинным указателем на строку, завершаемую null.

Дополнительные сведения о строках идентификаторов объектов, их предопределенных константах и соответствующих структурах см. в разделе Константы для CryptEncodeObject и CryptDecodeObject.

[in] pvStructInfo

Указатель на структуру для кодирования. Структура должна иметь тип, заданный lpszStructType.

[out] pbEncoded

Указатель на буфер для получения закодированной структуры. Если указанный буфер недостаточно велик, чтобы получить декодированную структуру, функция задает код ERROR_MORE_DATA и сохраняет требуемый размер буфера в байтах в переменной, на которую указывает pcbEncoded.

Этот параметр может иметь значение NULL , чтобы получить размер этих сведений для целей выделения памяти. Дополнительные сведения см. в разделе Извлечение данных неизвестной длины.

[in, out] pcbEncoded

Указатель на переменную DWORD , содержащую размер (в байтах) буфера, на который указывает параметр pbEncoded . Когда функция возвращает значение DWORD , содержит количество выделенных закодированных байтов, хранящихся в буфере.

Примечание При обработке данных, возвращаемых в буфере, приложения должны использовать фактический размер возвращаемых данных. Фактический размер может быть немного меньше размера буфера, указанного во входных данных. (На входных данных размеры буфера обычно указываются достаточно большими, чтобы убедиться, что максимально возможные выходные данные помещаются в буфер.) В выходных данных переменная, на которую указывает этот параметр, обновляется с учетом фактического размера данных, скопированных в буфер.

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

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

Если функция завершается сбоем, возвращаемое значение равно нулю (FALSE). Чтобы получить дополнительные сведения об ошибке, вызовите Метод GetLastError. Некоторые возможные коды ошибок перечислены в следующей таблице.

Код возврата	Описание
CRYPT_E_BAD_ENCODE	При кодировании произошла ошибка.
ERROR_FILE_NOT_FOUND	Не удалось найти функцию кодирования для указанных dwCertEncodingType и lpszStructType.
ERROR_MORE_DATA	Если буфер, заданный параметром pbEncoded , недостаточно велик для хранения возвращаемых данных, функция задает код ERROR_MORE_DATA и сохраняет требуемый размер буфера в байтах в переменной, на которую указывает pcbEncoded.

В случае сбоя функции GetLastError может вернуть ошибку кодирования и декодирования абстрактного синтаксиса (ASN.1). Сведения об этих ошибках см. в разделе Кодирование и декодирование возвращаемых значений ASN.1.

При кодировании криптографического объекта с помощью предпочтительной функции CryptEncodeObjectEx включается завершающий символ NULL . При декодировании с помощью предпочтительной функции CryptDecodeObjectEx завершающий символ NULL не сохраняется.

Примеры

Пример использования этой функции см. в разделах Пример программы C: создание запроса сертификата и Пример программы C: кодирование и декодирование ASN.1.

Требования


Минимальная версия клиента	Windows XP [классические приложения \| Приложения UWP]
Минимальная версия сервера	Windows Server 2003 [классические приложения \| Приложения UWP]
Целевая платформа	Windows
Header	wincrypt.h
Библиотека	Crypt32.lib
DLL	Crypt32.dll

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

CryptDecodeObject

CryptEncodeObjectEx

Функции кодирования и декодирования объектов

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