CSSM_RETURN CSSMDLI DL_DbDelete (CSSM_DL_HANDLE DLHandle, const char *DbName, const CSSM_NET_ADDRESS_PTR DbLocation, const CSSM_DB_USER_AUTHENTICATION_PTR UserAuthentication)
This function deletes all records from the specified data store and removes all state information associated with that data store.
- DLHandle (input)
The handle that describes the add-in data storage library module to be used to perform this function.
- DbName (input)
A pointer to the string containing the logical name of the data store.
- DbLocation (input/optional)
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 determine a storage service process and its location based on the DbName (for existing data stores) or can assume a default storage service process location. If the DbName does not distinguish the storage service process and a default cannot be assumed, the service cannot be performed and the operation fails.
- UserAuthentication (input/optional)
The caller's credential as required for obtaining access (and consequently deletion capability) to the data store. If no credentials are required for the specified data store, then user authentication must be NULL.
A CSSM_OK return value signifies that the function completed successfully. When CSSM_FAIL is returned, an error has occurred. Use CSSM_GetError to obtain the error code.
Invalid DL handle.
Invalid DB handle.
Caller is not authorized for operation.
Unable to update registry entry.
Delete caused an exception.