DL_DbOpen

If both a Table of Contents and Search form are not displayed in separate frames along with this one, you may wish to redisplay this book in a frameset, beginning with the first page.

HP Open Source Security for OpenVMS Volume 1:...

API Functions

DL_DbDelete

DL_DestroyRelation

DL_DbOpen

Library
Description
Errors

Parameters
Return Value
See Also

NAME

DL_DbOpen: CSSM_DL_DbOpen - Open a data store (CDSA)

SYNOPSIS

# include <cssm.h>

API:CSSM_RETURN CSSMAPI CSSM_DL_DbOpen(CSSM_DL_HANDLE DLHandle,const char *DbName,const CSSM_NET_ADDRESS *DbLocation,CSSM_DB_ACCESS_TYPE AccessRequest,const CSSM_ACCESS_CREDENTIALS *AccessCred,const void *OpenParameters,CSSM_DB_HANDLE *DbHandle)SPI:CSSM_RETURN CSSMDLI DL_DbOpen(CSSM_DL_HANDLE DLHandle,const char *DbName,const CSSM_NET_ADDRESS *DbLocation,CSSM_DB_ACCESS_TYPE AccessRequest,const CSSM_ACCESS_CREDENTIALS *AccessCred,const void *OpenParameters,CSSM_DB_HANDLE *DbHandle)

LIBRARY

Common Security Services Manager library (cdsa$incssm300_shr.exe)

PARAMETERS

`DLHandle` (input)
		The handle that describes the add-in data storagelibrary module to be used to perform this function.
`DbName` (input)
		A pointer to the string containing the logical nameof the data store.
`DbLocation` (input/optional)
		A pointer to a network address directly or indirectlyidentifying the location of the storage service process. If theinput is NULL, the module can determine a storage service process andits location based on the DbName (for existing data stores) or canassume a default storage service process location. If the DbNamedoes not distinguish the storage service process, the service cannotbe performed and the operation fails.
`AccessRequest` (input)
		An indicator of the requested access mode for thedata store, such as read-only or read-write.
`AccessCred` (input/optional)
		A pointer to the set of one or more credentialsbeing presented for authentication by the caller. These credentialsare required to obtain access to the specified data store. The credentialsstructure can contain multiple types of credentials, as requiredfor multi-factor authentication. The credential data can be an immediatevalue, such as a passphrase, PIN, certificate, or template of user-specificdata, or the caller can specify a callback function the DL can useto obtain one or more credentials. The required set of credentialsto access a particular data store is defined by the `DbInfo` recordcontaining meta-data for the specified data store. If credentialsare not required to access the specified data store, then this field canbe NULL.
`OpenParameters` (input/optional)
		A pointer to a module-specific set of parametersrequired to open the data store.
`DbHandle` (output)
		The handle to the opened data store. The value willbe set to CSSM_INVALID_HANDLE if the function fails.

DESCRIPTION

This function opens the data store with the specified logicalname under the specified access mode. If user authentication credentialsare required, they must be provided. Also, additional open parametersmay be required to open a given data store, and are supplied inthe OpenParameters.

RETURN VALUE

A CSSM_RETURN value indicating success or specifying a particularerror condition. The value CSSM_OK indicates success. All othervalues represent an error condition.

ERRORS

Errors are described in the CDSA Technical Standard.

CSSMERR_DL_DB_LOCKEDCSSMERR_DL_INVALID_ACCESS_REQUESTCSSMERR_DL_INVALID_DB_LOCATIONCSSMERR_DL_INVALID_DB_NAMECSSMERR_DL_DATASTORE_DOESNOT_EXISTCSSMERR_DL_INVALID_PARSING_MODULECSSMERR_DL_INVALID_OPEN_PARAMETERS