Certificates object

[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 Certificates object represents a collection of Certificate objects. Each Certificate object represents a single digital certificate.

The Certificates object exposes the following interfaces:

  • ICertificates2: Introduced in CAPICOM 2.0.
  • ICertificates: Introduced in CAPICOM 1.0.

When to use

The Certificates object is used to perform the following tasks:

  • Add or remove a Certificate object to or from the collection.
  • Generate a subset of the collection by finding a set of certificates or by displaying a dialog box to select the certificates.
  • Clear all the Certificate objects from the collection.
  • Retrieve the number of certificates in the collection.
  • Retrieve a specific Certificate object from the collection.
  • Iterate through the collection.

Members

The Certificates object has these types of members:

Methods

The Certificates object has these methods.

Method Description
Add Adds a Certificate object to the collection.
(Inherited from CertificatesICertificates2)
Clear Removes all Certificate objects from the collection.
(Inherited from CertificatesICertificates2)
Find Returns a Certificates object that contains all certificates that match the specified search criteria.
(Inherited from CertificatesICertificates2)
Remove Removes a single Certificate object from the collection.
(Inherited from CertificatesICertificates2)
Save Saves the certificates to a specified file.
(Inherited from CertificatesICertificates2)
Select Displays a dialog box for selecting certificates and returns a collection of those certificates selected.
(Inherited from CertificatesICertificates2)

 

Properties

The Certificates object has these properties.

Property Access type Description
_NewEnum
Read-only
Retrieves an IEnumVARIANT interface on an object that can be used to enumerate the collection. This property is hidden within Visual Basic Scripting Edition (VBScript).
Count
Read-only
Retrieves the number of Certificate objects in the collection.
Item
Read-only
Retrieves a Certificate object that represents the indexed certificate of the collection. This is the default property.
(Inherited from CertificatesICertificates2ICertificates)

 

Remarks

The Certificates object can be created, and it is safe for scripting. The ProgID for the Certificates object is "CAPICOM.Certificates.2".

CAPICOM 1.x: The ProgID for the Certificates object is "CAPICOM.Certificates.1".

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

See also

Cryptography Objects