CryptDecodeObject 函式 (wincrypt.h)

  • 發行項

CryptDecodeObject函式會解碼lpszStructType參數所指示之型別的結構。 建議使用 CryptDecodeObjectEx 作為 API，以大幅改善效能來執行相同的函式。

語法

BOOL CryptDecodeObject(
  [in]      DWORD      dwCertEncodingType,
  [in]      LPCSTR     lpszStructType,
  [in]      const BYTE *pbEncoded,
  [in]      DWORD      cbEncoded,
  [in]      DWORD      dwFlags,
  [out]     void       *pvStructInfo,
  [in, out] DWORD      *pcbStructInfo
);

參數

[in] dwCertEncodingType

使用的編碼類型。 將憑證和 訊息編碼類型 與位OR 作業結合在一起，一律可以接受，如下列範例所示：

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] pbEncoded

要解碼之編碼結構的指標。

[in] cbEncoded

pbEncoded所指向的位元組數目。

[in] dwFlags

定義下列旗標。 它們可以與位OR 運算結合。

值 意義
CRYPT_DECODE_NOCOPY_FLAG
 此旗標可以設定為表示已啟用「沒有複製」優化。 如果適用，此優化會更新 pvStructInfo 參數，以指向位於 pbEncoded 內的內容，而不是製作內容的複本，並將它附加至 pvStructInfo。 在適用的情況下，呼叫的應用程式需要配置較少的記憶體，而且執行速度較快，因為不會進行複本。 請注意，執行「沒有複製」解碼時的取捨是，除非釋放 pvStructInfo，否則無法釋放pbEncoded。
CRYPT_UNICODE_NAME_DECODE_DISABLE_IE4_UTF8_FLAG
 當解碼X509_UNICODE_NAME、X509_UNICODE_NAME_VALUE或X509_UNICODE_ANY_STRING時，適用此旗標。 根據預設，CERT_RDN_T61_STRING編碼值一開始會解碼為 UTF8。 如果 UTF8 解碼失敗，則會將值解碼為八位字元。 如果設定此旗標，它會略過將值解碼為 UTF8 的初始嘗試，並將值解碼為八位字元。
CRYPT_DECODE_TO_BE_SIGNED_FLAG
 根據預設， pbEncoded 指向的緩衝區內容包含已簽署的內容和簽章。 如果設定此旗標，緩衝區只會包含「要簽署」的內容。 此旗標適用于X509_CERT_TO_BE_SIGNED、X509_CERT_CRL_TO_BE_SIGNED、X509_CRT_REQUEST_TO_BE_SIGNED和X509_KEYGEN_REQUEST_TO_BE_SIGNED物件。
CRYPT_DECODE_SHARE_OID_STRING_FLAG
 設定此旗標時，OID 字串會配置在 Crypt32.dll 中，並共用，而不是複製到傳回的資料結構中。 如果在卸載呼叫端之前未卸載 Crypt32.dll，則可以設定此旗標。
CRYPT_DECODE_NO_SIGNATURE_BYTE_REVERSAL_FLAG
 根據預設，簽章位元組會反轉。 如果設定此旗標，則會禁止此位元組反轉。

[out] pvStructInfo

要接收已解碼結構的緩衝區指標。 當指定的緩衝區不夠大而無法接收解碼的結構時，函式會設定ERROR_MORE_DATA程式碼，並將所需的緩衝區大小以位元組為單位儲存在 由tructInfo所指向的變數中。

此參數可以是 Null ，可擷取此資訊的大小以供記憶體配置之用。 如需詳細資訊，請參閱 擷取未知長度的資料。

[in, out] pcbStructInfo

DWORD值的指標，指定pvStructInfo參數所指向之緩衝區的大小，以位元組為單位。 當函式傳回時，這個 DWORD 值會包含複製到 pvStructInfo的解碼資料大小。 由 wifiStructInfo指向之變數中包含的大小可以指出大於解碼結構的大小，因為解碼的結構可以包含其他結構的指標。 此大小是解碼結構和其他所指向結構所需的大小總和。

注意 處理緩衝區中傳回的資料時，應用程式必須使用傳回的資料實際大小。 實際大小可能會稍微小於輸入中指定的緩衝區大小。 (輸入時，通常會指定足夠的緩衝區大小，以確保最大的可能輸出資料符合 buffer。) On 輸出中，此參數所指向的變數會更新，以反映複製到緩衝區的實際資料大小。
 

傳回值

如果函式成功，傳回值為非零 (TRUE) 。

如果函式失敗，傳回值為零， (FALSE) 。 如需擴充的錯誤資訊，請呼叫 GetLastError。 下表列出一些可能的錯誤碼。

傳回碼 描述
CRYPT_E_BAD_ENCODE
 解碼時發生錯誤。
ERROR_FILE_NOT_FOUND
 找不到指定dwCertEncodingType和lpszStructType的解碼函式
ERROR_MORE_DATA
 如果 pvStructInfo 參數指定的緩衝區不夠大，無法保存傳回的資料，此函式會設定ERROR_MORE_DATA程式碼，並將所需的緩衝區大小以位元組為單位儲存在 由ERROR_MORE_DATA info指向的變數中。
 

如果函式失敗， GetLastError 可能會傳回 抽象語法標記法 1 (ASN.1) 編碼/解碼錯誤。 如需這些錯誤的相關資訊，請參閱 ASN.1 編碼/解碼傳回值。

備註

使用慣用 CryptEncodeObjectEx 函式編碼密碼編譯物件時，會包含終止 的 Null 字元。 解碼時，使用慣用 的 CryptDecodeObjectEx 函式，不會保留終止 的 Null 字元。

範例

如需使用此函式的範例，請參閱 範例 C 程式：ASN.1 編碼和解碼。

規格需求

   
最低支援的用戶端 Windows XP [傳統型應用程式 |UWP 應用程式]
最低支援的伺服器 Windows Server 2003 [傳統型應用程式 |UWP 應用程式]
目標平台 Windows
標頭 wincrypt.h
程式庫 Crypt32.lib
Dll Crypt32.dll

另請參閱

CryptDecodeObjectEx

CryptEncodeObject

物件編碼和解碼函式