Collaboration diagram for DBM routines:

Classes
struct	apr_datum_t
Modules
	SDBM library
Defines
#define	APR_DBM_READONLY 1
#define	APR_DBM_READWRITE 2
#define	APR_DBM_RWCREATE 3
#define	APR_DBM_RWTRUNC 4
Typedefs
typedef struct apr_dbm_t	apr_dbm_t
Functions
	APU_DECLARE (apr_status_t) apr_dbm_open_ex(apr_dbm_t **dbm
	APU_DECLARE (void) apr_dbm_close(apr_dbm_t *dbm)
	APU_DECLARE (char ) apr_dbm_geterror(apr_dbm_t dbm
Variables
const char *	type
const char const char *	name
const char const char apr_int32_t	mode
const char const char apr_int32_t apr_fileperms_t	perm
const char const char apr_int32_t apr_fileperms_t apr_pool_t *	cntxt
apr_datum_t	key
apr_datum_t apr_datum_t *	pvalue
apr_datum_t apr_datum_t	value
apr_datum_t *	pkey
apr_datum_t	data
int *	errcode
int char *	errbuf
int char apr_size_t	errbufsize
const char const char *	pathname
const char const char const char **	used1
const char const char const char const char **	used2

Define Documentation

#define APR_DBM_READONLY 1

open for read-only access

Definition at line 56 of file apr_dbm.h.

#define APR_DBM_READWRITE 2

open for read-write access

Definition at line 57 of file apr_dbm.h.

#define APR_DBM_RWCREATE 3

open for r/w, create if needed

Definition at line 58 of file apr_dbm.h.

#define APR_DBM_RWTRUNC 4

open for r/w, truncating an existing DB if present

Definition at line 59 of file apr_dbm.h.

Typedef Documentation

typedef struct apr_dbm_t apr_dbm_t

Structure for referencing a dbm

Definition at line 42 of file apr_dbm.h.

Function Documentation

APU_DECLARE ( apr_status_t )

Open a dbm file by file name and type of DBM

Parameters:

dbm	The newly opened database
type	The type of the DBM (not all may be available at run time) db for Berkeley DB files gdbm for GDBM files ndbm for NDBM files sdbm for SDBM files (always available) default for the default DBM type
name	The dbm file name to open
mode	The flag value APR_DBM_READONLY open for read-only access APR_DBM_READWRITE open for read-write access APR_DBM_RWCREATE open for r/w, create if needed APR_DBM_RWTRUNC open for r/w, truncate if already there
perm	Permissions to apply to if created
cntxt	The pool to use when creating the dbm

Remarks:: The dbm name may not be a true file name, as many dbm packages append suffixes for seperate data and index files.

Bug:: In apr-util 0.9 and 1.x, the type arg was case insensitive. This was highly inefficient, and as of 2.x the dbm name must be provided in the correct case (lower case for all bundled providers)

Open a dbm file by file name

Parameters:

dbm	The newly opened database
name	The dbm file name to open
mode	The flag value APR_DBM_READONLY open for read-only access APR_DBM_READWRITE open for read-write access APR_DBM_RWCREATE open for r/w, create if needed APR_DBM_RWTRUNC open for r/w, truncate if already there
perm	Permissions to apply to if created
cntxt	The pool to use when creating the dbm

Remarks:: The dbm name may not be a true file name, as many dbm packages append suffixes for seperate data and index files.

Fetch a dbm record value by key

Parameters:

dbm	The database
key	The key datum to find this record
pvalue	The value datum retrieved for this record

Store a dbm record value by key

Parameters:

dbm	The database
key	The key datum to store this record by
value	The value datum to store in this record

Delete a dbm record value by key

Parameters:

dbm	The database
key	The key datum of the record to delete

Remarks:: It is not an error to delete a non-existent record.

Search for a key within the dbm

Parameters:

dbm	The database
key	The datum describing a key to test

Retrieve the first record key from a dbm

Parameters:

dbm	The database
pkey	The key datum of the first record

Retrieve the next record key from a dbm

Parameters:

dbm	The database
pkey	The key datum of the next record

If the specified file/path were passed to apr_dbm_open(), return the actual file/path names which would be (created and) used. At most, two files may be used; used2 may be NULL if only one file is used.

Parameters:

pool	The pool for allocating used1 and used2.
type	The type of DBM you require info on

See also:: apr_dbm_open_ex

Parameters:

pathname	The path name to generate used-names from.
used1	The first pathname used by the apr_dbm implementation.
used2	The second pathname used by apr_dbm. If only one file is used by the specific implementation, this will be set to NULL.

Returns:: An error if the specified type is invalid.

Remarks:: The dbm file(s) don't need to exist. This function only manipulates the pathnames.

APU_DECLARE ( void )

Close a dbm file previously opened by apr_dbm_open

Parameters:

dbm	The database to close

Proactively toss any memory associated with the apr_datum_t.

Parameters:

dbm	The database
data	The datum to free.

If the specified file/path were passed to apr_dbm_open(), return the actual file/path names which would be (created and) used. At most, two files may be used; used2 may be NULL if only one file is used.

Parameters:

pool	The pool for allocating used1 and used2.
pathname	The path name to generate used-names from.
used1	The first pathname used by the apr_dbm implementation.
used2	The second pathname used by apr_dbm. If only one file is used by the specific implementation, this will be set to NULL.

Remarks:: The dbm file(s) don't need to exist. This function only manipulates the pathnames.

Sort all of the registerd functions for a given hook

Print all of the information about the current hook. This is used for debugging purposes.

Parameters:

szName	The name of the hook
aszPre	All of the functions in the predecessor array
aszSucc	All of the functions in the successor array

Remove all currently registered functions.

Set reslist cleanup order.

Parameters:

reslist	The resource list.
mode	Cleanup order mode APR_RESLIST_CLEANUP_DEFAULT default pool cleanup order APR_RESLIST_CLEANUP_FIRST use pool pre cleanup

Remarks:: If APR_RESLIST_CLEANUP_FIRST is used the destructors will be called before child pools of the pool used to create the reslist are destroyed. This allows to explicitly destroy the child pools inside reslist destructors.

Initialize the SHA digest

Parameters:

context The SHA context to initialize

Update the SHA digest

Parameters:

context	The SHA1 context to update
input	The buffer to add to the SHA digest
inputLen	The length of the input buffer

Update the SHA digest with binary data

Parameters:

context	The SHA1 context to update
input	The buffer to add to the SHA digest
inputLen	The length of the input buffer

Finish computing the SHA digest

Parameters:

digest	the output buffer in which to store the digest
context	The context to finalize

Format a UUID into a string, following the standard format

Parameters:

buffer	The buffer to place the formatted UUID string into. It must be at least APR_UUID_FORMATTED_LENGTH + 1 bytes long to hold the formatted UUID and a null terminator
uuid	The UUID to format

Converts an XML element tree to flat text

Parameters:

p	The pool to allocate out of
elem	The XML element to convert
style	How to covert the XML. One of: APR_XML_X2T_FULL start tag, contents, end tag APR_XML_X2T_INNER contents only APR_XML_X2T_LANG_INNER xml:lang + inner contents APR_XML_X2T_FULL_NS_LANG FULL + ns defns + xml:lang
namespaces	The namespace of the current XML element
ns_map	Namespace mapping
pbuf	Buffer to put the converted text into
psize	Size of the converted text

Quote an XML element

Parameters:

p	The pool to allocate out of
elem	The element to quote

APU_DECLARE ( char * )

Report more information when an apr_dbm function fails.

Parameters:

dbm	The database
errcode	A DBM-specific value for the error (for logging). If this isn't needed, it may be NULL.
errbuf	Location to store the error text
errbufsize	The size of the provided buffer