HRS_DbDeleteBIR

NAME

CSSM_HRS_DbDeleteBIR, HRS_DbDeleteBIR — Deletes a BIR in an open database

SYNOPSIS

#include <hrs.h>

API

CSSM_RETURN CSSMAPI CSSM_HRS_DbDeleteBIR
        (CSSM_HRS_HANDLE ModuleHandle,
        CSSM_HRS_DB_HANDLE DbHandle,
        const CSSM_GUID *KeyValue);

SPI

CSSM_RETURN CSSMHRI HRS_DbDeleteBIR
        (CSSM_HRS_HANDLE ModuleHandle,
        CSSM_HRS_DB_HANDLE DbHandle,
        const CSSM_GUID *KeyValue);

LIBRARY

HRS Extensible Module Manager (cdsa$inhrsemm_shr.exe)

PARAMETERS

The parameter definitions are the same for the API and the SPI.

`ModuleHandle` (input)		The handle of the attached HRS service provider.
`DbHandle` (input)		The handle to the open database.
`KeyValue` (input)		The GUID of the BIR to be deleted.

DESCRIPTION

This function deletes the BIR identified by the KeyValue parameter in the open database identified by the DbHandle parameter.

If there is a cursor set to the deleted BIR, then the cursor is moved to the next sequential BIR (or set to the start of the database if there are no more records).

RETURN VALUE

A CSSM_RETURN value indicating success or specifying a particular error condition. The value CSSM_OK indicates success. All other values represent an error condition.

ERRORS

Errors are described in the CDSA Technical Standard.

CSSMERR_CSSM_NOT_INITIALIZED CSSMERR_CSSM_FUNCTION_FAILED CSSMERR_CSSM_FUNCTION_NOT_IMPLEMENTED CSSMERR_CSSM_FUNCTION_INTEGRITY_FAIL CSSMERR_HRS_END_OF_DATABASE CSSMERR_HRS_RECORD_NOT_FOUND