DL_DbDelete

If both a Table of Contents and Search form are not displayed in separate frames along with this one, you may wish to redisplay this book in a frameset, beginning with the first page.

HP Open Source Security for OpenVMS Volume 1:...

API Functions

DL_DbCreate

DL_DbOpen

DL_DbDelete

Library
Description
Errors

Parameters
Return Value
See Also

NAME

DL_DbDelete: CSSM_DL_DbDelete - Delete all records (CDSA)

SYNOPSIS

# include <cssm.h>

API:CSSM_RETURN CSSMAPI CSSM_DL_DbDelete(CSSM_DL_HANDLE DLHandle,const char *DbName,const CSSM_NET_ADDRESS *DbLocation,const CSSM_ACCESS_CREDENTIALS *AccessCred)SPI:CSSM_RETURN CSSMDLI DL_DbDelete(CSSM_DL_HANDLE DLHandle,const char *DbName,const CSSM_NET_ADDRESS *DbLocation,const CSSM_ACCESS_CREDENTIALS *AccessCred)

LIBRARY

Common Security Services Manager library (cdsa$incssm300_shr.exe)

PARAMETERS

`DLHandle` (input)
		The handle that describes the add-in data storagelibrary module to be used to perform this function.
`DbName` (input)
		A pointer to the string containing the logical nameof the data store.
`DbLocation` (input/optional)
		A pointer to a network address directly or indirectlyidentifying the location of the storage service process. If theinput is NULL, the module can assume a default storage service processlocation. If the `DbName` does not distinguishthe storage service process, the service cannot be performed andthe operation fails.
`AccessCred` (input/optional)
		A pointer to the set of one or more credentialsbeing presented for authentication by the caller. These credentialsare required to obtain access to the specified data store. The credentialsstructure can contain multiple types of credentials, as requiredfor multi-factor authentication. The credential data can be an immediatevalue, such as a passphrase, PIN, certificate, or template of user-specificdata, or the caller can specify a callback function the DL can useto obtain one or more credentials. The required set of credentialsto access a particular data store is defined by the `DbInfo` recordcontaining meta-data for the specified data store. If credentialsare not required to access the specified data store, then this field canbe NULL.

DESCRIPTION

This function deletes all records from the specified datastore and removes all state information associated with that datastore.

RETURN VALUE

A CSSM_RETURN value indicating success or specifying a particularerror condition. The value CSSM_OK indicates success. All othervalues represent an error condition.

ERRORS

Errors are described in the CDSA Technical Standard.

CSSMERR_DL_DATASTORE_DOESNOT_EXISTCSSMERR_DL_DATASTORE_IS_OPENCSSMERR_DL_INVALID_DB_LOCATIONCSSMERR_DL_INVALID_DB_NAME