This function opens the data store with the specified logical name under the specified access mode. If user authentication credentials are required, they must be provided. Also, additional open parameters may be required to open a given data store and are supplied in the OpenParameters.

CSSM_DB_HANDLE CSSMAPI CSSM_DL_DbOpen
                 (CSSM_DL_HANDLE DLHandle,
                 const char *DbName,
                 const CSSM_DB_ACCESS_TYPE_PTR AccessRequest,
                 const CSSM_USER_AUTHENTICATION_PTR UserAuthentication,
                 const void *OpenParameters)

Input

DLHandle

The handle that describes the DL module to be used to perform this function.

DbName

A pointer to the string containing the logical name of the data store.

AccessRequest

An indicator of the requested access mode for the data store, such as read-only or read/write.

Input/optional

UserAuthentication

The caller's credentials as required for obtaining access to the data store. If no credentials are required for the specified data store, then user authentication must be NULL.

OpenParameters

A pointer to a module-specific set of parameters required to open the data store.

The handle to the opened data store. If the handle is NULL, an error has occurred. Use CSSM_GetError to obtain the error code.

CSSM_DL_DbClose