Framework EDI Reference. Methods and Properties
ediSecurities. RemoveCertificate

Removes an X.509 certificate from the certificate store.

Syntax

<lRetval> = object. RemoveCertificate(<sSubjectName>, <sIssuerName>, <sHexSerialNumber>, [<sServiceProvider>], [<lProviderType>])

Parameters

• sSubjectName - Subject name of the certificate to remove.
• sIssuerName - Issuer name of the certificate to remove.
• sHexSerialNumber - Serial number of the certificate remove in hexadecimal notation.
• sServiceProvider - Optional.  CSP used to open the certificate store. If none is specified, the default CSP is used.
• lProviderType - Optional.  Service provider type.  If none is specified then the default service provider type is used.  If the Service Provider name has been specified then the service provider type of that service provider is used.  For the list of possible provider types please see Cryptographic Service Provider Type Constants.

Returns

Returns 1 if the operation is successful; otherwise returns 0 if the operation fails.

Remarks

The sSubjectName, sIssuerName and sHexSerialNumber are used to search for the certificate in the certificate store.  See Locating a Digital Certificate.

The sServiceProvider and lProviderType  specify the CSP whose security services will be used.  If sServiceProvider and/or lProviderType are not specified, the default CSP database is used, which is specified by DefaultProviderName and ServiceProviderType.

The default certificate store is specified by the properties DefaultCertSystemStoreName and DefaultCertSystemStoreLocation.

Note: The certificate is only removed from the certificate store but the certificate file is not physically deleted from the system.

Example:

Dim oEdiDoc As Fredi.ediDocument
Dim oSecurities As Fredi.ediSecurities

' Create instance of Framework EDI.
Set oEdiDoc = New Fredi.ediDocument

' Get securities object.
Set oSecurities = oEdiDoc.GetSecurities

' Set the default certificate store
oSecurities.DefaultCertSystemStoreName = "My" ' Case sensitive

' Set the default certificate store location
oSecurities.DefaultCertSystemStoreLocation = "CurrentUser"

If Not oSecurities.IsCertificateExists("Edidev Test Certificate") Then

MsgBox "Test certificate 'Edidev Test Certificate' does not exists in certificate store."

Else

If oSecurities.RemoveCertificate("Edidev Test Certificate", "Edidev Test Certificate", "") = 1 Then

MsgBox "Successfully removed test certificate 'Edidev Test Certificate'."

Else

MsgBox "Failed to remove test certificate"

End If

End If

Sample

M_RemoveCertificate.zip