HRS_DbOpen

~~~
NAME
  CSSM_HRS_DbOpen, HRS_DbOpen

SYNOPSIS

#include <hrs.h>

API
  CSSM_RETURN CSSMAPI CSSM_HRS_DbOpen(
                         CSSM_HRS_HANDLE ModuleHandle,
                         const uint8 *DbName,
                         CSSM_HRS_DB_ACCESS_TYPE AccessRequest,
                         CSSM_HRS_DB_HANDLE_PTR DbHandle,
                         CSSM_HRS_DB_CURSOR_PTR Cursor);
SPI
  CSSM_RETURN CSSMHRI HRS_DbOpen(
                         CSSM_HRS_HANDLE ModuleHandle,
                         const uint8 *DbName,
                         CSSM_HRS_DB_ACCESS_TYPE AccessRequest,
                         CSSM_HRS_DB_HANDLE_PTR DbHandle,
                         CSSM_HRS_DB_CURSOR_PTR Cursor);

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.
  AccessRequest (input)       An indicator of the requested
                              access mode for the database, such
                              as read or write.
  DbHandle (output)           The handle to the opened data
                              store. The value will be set to
                              CSSM_HRS_DB_INVALID_HANDLE if the
                              function fails.
  Cursor (output)             A handle that can be used to iterate
                              through the database.

DESCRIPTION
  This function opens the data store with the specified name
  under the specified access mode. A database Cursor is set to
  point to the first record in the database.

  Note that the default database (if any) is always open.

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_DOES_NOT_EXIST
  CSSMERR_HRS_DATABASE_IS_LOCKED
  CSSMERR_HRS_INVALID_ACCESS_REQUEST
  CSSMERR_HRS_INVALID_DATABASE_NAME
  CSSMERR_HRS_UNABLE_TO_OPEN_DATABASE