HELPLIB.HLB  —  CDSA  CDSA_API, HRS DbDelete
 NAME
   CSSM_HRS_DbDelete, HRS_DbDelete

 SYNOPSIS

 #include <hrs.h>

 API
   CSSM_RETURN CSSMAPI CSSM_HRS_DbDelete(
                          CSSM_HRS_HANDLE ModuleHandle,
                          const uint8 *DbName);
 SPI
   CSSM_RETURN CSSMHRI HRS_DbDelete(
                          CSSM_HRS_HANDLE ModuleHandle,
                          const uint8 *DbName);

 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.
   DbName (input)              A pointer to the null-terminated string
                               containing the name of the database to
                               be deleted.

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

 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.  See CDSA.

   CSSMERR_CSSM_NOT_INITIALIZED
   CSSMERR_CSSM_FUNCTION_FAILED
   CSSMERR_CSSM_FUNCTION_NOT_IMPLEMENTED
   CSSMERR_CSSM_FUNCTION_INTEGRITY_FAIL
   CSSMERR_HRS_DATABASE_IS_OPEN
   CSSMERR_HRS_INVALID_DATABASE_NAME
Close Help