NAME

DL_DataDelete

SYNOPSIS

CSSM_RETURN CSSMDLI DL_DataDelete
    (CSSM_DL__DB_HANDLE DLDBHandle,
    const CSSM_DB_UNIQUE_RECORD_PTR UniqueRecordIdentifier)

DESCRIPTION

This function removes from the specified data store, the data record specified by the unique record identifier.

PARAMETERS

DLDBHandle (input)

The handle pair that describes the add-in data storage library module to be used to perform this function and the open data store from which to delete the specified data record.

UniqueRecordIdentifier (input)

A pointer to a CSSM_DB_UNIQUE_RECORD identifier containing unique identification of the data record to be deleted from the data store. Once the associated record has been deleted, this unique record identifier cannot be used in future references.

RETURN VALUE

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.

ERRORS

CSSM_DL_INVALID_DL_HANDLE

Invalid data storage library handle.

CSSM_DL_INVALID_DB_HANDLE

Invalid Data Storage handle.

CSSM_DL_INVALID_RECORD_IDENTIFIER

Invalid data pointer.

CSSM_DL_DATA_DELETE_FAIL

Delete caused an exception.

SEE ALSO

CSSM_DL_DataInsert