Export (0) Print
Expand All

ICertificate2::Save method

[CAPICOM is a 32-bit only component that is available for use in the following operating systems: Windows Server 2008, Windows Vista, and Windows XP. Instead, use the X509Certificate2 Class in the System.Security.Cryptography.X509Certificates namespace.]

The Save method saves the certificate to a file. This method was introduced in CAPICOM 2.0.

Syntax


Certificate.Save( _
  ByVal FileName, _
  [ ByVal Password ], _
  [ ByVal SaveAs ], _
  [ ByVal IncludeOption ] _
)

Parameters

FileName [in]

A string that contains the name of the output file where the certificate will be saved.

Password [in, optional]

A string that contains the plaintext password for a private key file. The password can contain up to 32 Unicode characters, including a terminating null character. For information about protecting the password, see Handling Passwords.

SaveAs [in, optional]

A value of the CAPICOM_CERTIFICATE_SAVE_AS_TYPE enumeration that specifies the format of the output file. The default is CAPICOM_CERTIFICATE_SAVE_AS_CER. The following table shows the possible values.

ValueMeaning
CAPICOM_CERTIFICATE_SAVE_AS_CER

The output file will be formatted as a .cer file with no private keys saved.

CAPICOM_CERTIFICATE_SAVE_AS_PFX

The output file will be formatted as a .pfx (PKCS #12) file and any associated private keys that are exportable will also be saved.

 

IncludeOption [in, optional]

A value of the CAPICOM_CERTIFICATE_INCLUDE_OPTION enumeration that specifies how many certificates in the chain are saved to the output file. The default is CAPICOM_CERTIFICATE_INCLUDE_END_ENTITY_ONLY. The following table shows the possible values.

ValueMeaning
CAPICOM_CERTIFICATE_INCLUDE_CHAIN_EXCEPT_ROOT

Saves all certificates in the chain with the exception of the root entity

CAPICOM_CERTIFICATE_INCLUDE_WHOLE_CHAIN

Saves the complete certificate chain

CAPICOM_CERTIFICATE_INCLUDE_END_ENTITY_ONLY

Saves only the end entity certificate

 

Return value

This method does not return a value.

Remarks

This method raises CAPICOM_E_NOT_ALLOWED when it is scripted from a web-based application.

Requirements

End of client support

Windows Vista

End of server support

Windows Server 2008

Redistributable

CAPICOM 2.0 or later on Windows Server 2003 and Windows XP

DLL

Capicom.dll

 

 

Community Additions

ADD
Show:
© 2015 Microsoft