IX509Enrollment::CreatePFX method (certenroll.h)
The CreatePFX method creates a Personal Information Exchange (PFX) message. The message is contained in a byte array that is encoded by using Distinguished Encoding Rules (DER) as defined by the Abstract Syntax Notation One (ASN.1) standard. The DER-encoded byte array is represented by a string that is either a pure binary sequence or is Unicode encoded.
HRESULT CreatePFX( [in] BSTR strPassword, [in] PFXExportOptions ExportOptions, [in] EncodingType Encoding, [out] BSTR *pValue );
A BSTR variable that contains a password for the PFX message. This can be NULL to indicate that no password is used. When you have finished using the password, clear it from memory by calling the SecureZeroMemory function. For more information about protecting the password, see Handling Passwords.
A PFXExportOptions enumeration value that specifies how much of the certificate chain is exported. You can export the certificate only, the certificate chain without the root, or the entire chain.
An EncodingType enumeration value that specifies the type of Unicode encoding applied to the DER-encoded message. The default value is XCN_CRYPT_STRING_BASE64.
Pointer to a BSTR variable that contains the DER-encoded PFX message.
If the function succeeds, the function returns S_OK.
If the function fails, it returns an HRESULT value that indicates the error. Possible values include, but are not limited to, those in the following table. For a list of common error codes, see Common HRESULT Values.
||The certificate cannot be found.|
||No certificate chain can be found.|
||The enrollment object has not been initialized.|
The PFX format is also known as PKCS #12. The CreatePFX method:
- Opens the certificate store in memory for the default provider.
- Adds the installed certificate to the store or builds the certificate chain adds a link to it.
- Exports the certificate and the private key to a PFX message depending on the export options specified.
- Encodes the exported message by using DER.
Before calling this method, you must initialize the IX509Enrollment object by calling one of the following methods.Enroll method.
|Minimum supported client||Windows Vista [desktop apps only]|
|Minimum supported server||Windows Server 2008 [desktop apps only]|