Framework EDI Reference. Methods and Properties
ediSecurities. DeleteKeyContainer

Delete an existing key container in the Cryptographic Service Provider (CSP) database.

Syntax:

<lretval> = object.DeleteKeyContainer(<sKeyContainerName>, [<sServiceProvider>], [<lProviderType>])

Parameters:

• sKeyContainerName - Name of the key container to delete.
• sServiceProvider - Optional.  Name of the Service Provider that the key container is deleted from.  The Service Provider has to be existing in the system already.  If none is specified then the default Service Provider is used.
• lProviderType - Optional.  The type of the Service Provider that the key container is being deleted from.  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:

Warning.  When a key container is deleted, it cannot be recovered or undone unless some form of backup was undertaken.  Furthermore, some security services will no longer work in Windows if those services were dependent on the deleted key container for security.

The sServiceProvider and lProviderType specify the CSP that has the key container to delete.  If sServiceProvider and/or lProviderType are not specified, the default CSP database is used, which is specified by DefaultProviderName andServiceProviderType.  The type of database, whether machine key set or user key set, is specified using ediDocument.Option by the constant OptDocument_MachineKeySet.

Example:

Set oSecurities = oEdiDoc.GetSecurities

' Creates a new key container for hypothetical trading partner.
oSecurities.DeleteKeyContainer sKeyContainerName
oSecurities.CreateKeyContainer sKeyContainerName

'Export private and public key container to a file
oSecurities.ExportExchangeKeyPair sExportFileName, sPassword, sKeyContainerName, sProviderName

Sample

M_DeleteKeyContainer.zip