cryptEncodeObject 函式 (wincrypt.h)
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
使用的編碼類型。 將憑證和 訊息編碼類型 與位OR 作業結合在一起,一律可以接受,如下列範例所示:
X509_ASN_ENCODING |PKCS_7_ASN_ENCODING
目前定義的編碼類型如下:
- X509_ASN_ENCODING
- PKCS_7_ASN_ENCODING
[in] lpszStructType
定義結構類型的 OID 指標。 如果 lpszStructType 參數的高序單字為零,則低順序字組會指定指定結構類型的整數識別碼。 否則,此參數是 Null 終止字串的長指標。
如需物件識別碼字串、其預先定義的常數和對應的結構的詳細資訊,請參閱 CryptEncodeObject 和 CryptDecodeObject 的常數。
[in] pvStructInfo
要編碼之 結構的指標。 結構必須是 lpszStructType所指定的類型。
[out] pbEncoded
要接收編碼結構的緩衝區指標。 當指定的緩衝區不夠大而無法接收解碼的結構時,函式會設定ERROR_MORE_DATA程式碼,並將所需的緩衝區大小以位元組為單位儲存在 由coded指向的變數中。
此參數可以是 Null ,可擷取此資訊的大小以供記憶體配置之用。 如需詳細資訊,請參閱 擷取未知長度的資料。
[in, out] pcbEncoded
DWORD變數的指標,其中包含pbEncoded參數所指向之緩衝區的大小,以位元組為單位。 當函式傳回時, DWORD 值會包含儲存在緩衝區中配置的編碼位元組數目。
傳回值
如果函式成功,傳回值為非零 (TRUE) 。
如果函式失敗,傳回值為零, (FALSE) 。 如需擴充的錯誤資訊,請呼叫 GetLastError。 下表列出一些可能的錯誤碼。
傳回碼 | 描述 |
---|---|
|
編碼時發生錯誤。 |
|
找不到指定 dwCertEncodingType 和 lpszStructType的編碼函式。 |
|
如果 pbEncoded 參數指定的緩衝區不夠大,無法保存傳回的資料,函式會設定ERROR_MORE_DATA程式碼,並將所需的緩衝區大小以位元組為單位儲存在 由coded指向的變數中。 |
如果函式失敗, GetLastError 可能會傳回 抽象語法標記法 1 (ASN.1) 編碼/解碼錯誤。 如需這些錯誤的相關資訊,請參閱 ASN.1 編碼/解碼傳回值。
備註
使用慣用 CryptEncodeObjectEx 函式編碼密碼編譯物件時,會包含終止 的 Null 字元。 解碼時,使用慣用 的 CryptDecodeObjectEx 函式,不會保留終止 的 Null 字元。
範例
如需使用此函式的範例,請參閱 範例 C 程式:提出憑證要求 和 範例 C 程式:ASN.1 編碼和解碼。
規格需求
最低支援的用戶端 | Windows XP [傳統型應用程式 |UWP 應用程式] |
最低支援的伺服器 | Windows Server 2003 [傳統型應用程式 |UWP 應用程式] |
目標平台 | Windows |
標頭 | wincrypt.h |
程式庫 | Crypt32.lib |
Dll | Crypt32.dll |