DL_DbDelete(3)DL_DbDelete(3)NAME
DL_DbDelete, CSSM_DL_DbDelete - Delete all records (CDSA)
SYNOPSIS
# include <cdsa/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 *Access‐
Cred)
LIBRARY
Common Security Services Manager library (libcssm.so)
PARAMETERS
The handle that describes the add-in data storage library module to be
used to perform this function. A pointer to the string containing the
logical name of the data store. A pointer to a network address
directly or indirectly identifying the location of the storage service
process. If the input is NULL, the module can assume a default storage
service process location. If the DbName does not distinguish the stor‐
age service process, the service cannot be performed and the operation
fails. A pointer to the set of one or more credentials being presented
for authentication by the caller. These credentials are required to
obtain access to the specified data store. The credentials structure
can contain multiple types of credentials, as required for multi-factor
authentication. The credential data can be an immediate value, such as
a passphrase, PIN, certificate, or template of user-specific data, or
the caller can specify a callback function the DL can use to obtain one
or more credentials. The required set of credentials to access a par‐
ticular data store is defined by the DbInfo record containing meta-data
for the specified data store. If credentials are not required to access
the specified data store, then this field can be NULL.
DESCRIPTION
This function deletes all records from the specified data store and
removes all state information associated with that data store.
RETURN VALUE
A CSSM_RETURN value indicating success or specifying a particular error
condition. The value CSSM_OK indicates success. All other values repre‐
sent an error condition.
ERRORS
Errors are described in the CDSA technical standard. See
CDSA_intro(3). CSSMERR_DL_DATASTORE_DOESNOT_EXIST CSSMERR_DL_DATAS‐
TORE_IS_OPEN CSSMERR_DL_INVALID_DB_LOCATION CSSMERR_DL_INVALID_DB_NAME
SEE ALSO
Books
Intel CDSA Application Developer's Guide (see CDSA_intro(3))
Reference Pages
Functions for the CSSM API:
CSSM_DL_DbCreate(3), CSSM_DL_DbOpen(3), CSSM_DL_DbClose(3)
Functions for the DL SPI:
DL_DbCreate(3), DL_DbOpen(3), DL_DbClose(3)DL_DbDelete(3)