Certificates.Save method

Article
06/08/2022

[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 X509Certificate2Collection Class in the System.Security.Cryptography.X509Certificates namespace.]

The Save method saves the Certificate objects in the collection.

Syntax

Certificates.Save( _
  ByVal FileName, _
  [ ByVal Password ], _
  [ ByVal SaveAs ], _
  [ ByVal ExportFlag ] _
)

Parameters

FileName [in]

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

Password [in, optional]

A string that contains the plaintext password for a private key file. The default value is the empty string (""). Up to 32 Unicode characters, including a terminating null character, can be used for the password. For information about protecting the password, see Handling Passwords.

SaveAs [in, optional]

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

Value	Meaning
CAPICOM_CERTIFICATES_SAVE_AS_PFX	The certificates are saved as a PFX.
CAPICOM_CERTIFICATES_SAVE_AS_PKCS7	The certificates are saved as a PKCS #7.
CAPICOM_CERTIFICATES_SAVE_AS_SERIALIZED	The certificates are saved as serialized.

ExportFlag [in, optional]

A value of the CAPICOM_EXPORT_FLAG enumeration that specifies whether any private key export errors are ignored. The default is CAPICOM_EXPORT_DEFAULT. The following table shows the possible values.

Value	Meaning
CAPICOM_EXPORT_DEFAULT	Private key export errors are not ignored.
CAPICOM_EXPORT_IGNORE_PRIVATE_KEY_NOT_EXPORTABLE_ERROR	Private key export errors are ignored.

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.

The Certificate objects can be retrieved by using the Store.Load method.

Requirements

Requirement	Value
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