Hints DB interface: convert from macros to inlinable functions.
[exim.git] / src / src / dbfunctions.h
1 /*************************************************
2 *     Exim - an Internet mail transport agent    *
3 *************************************************/
4
5 /* Copyright (c) University of Cambridge 1995 - 2021 */
6 /* See the file NOTICE for conditions of use and distribution. */
7
8 #ifndef DBFUNCTIONS_H
9 #define DBFUNCTIONS_H
10
11 /* Functions for reading/writing exim database files */
12
13 void     dbfn_close(open_db *);
14 int      dbfn_delete(open_db *, const uschar *);
15 open_db *dbfn_open(uschar *, int, open_db *, BOOL, BOOL);
16 void    *dbfn_read_with_length(open_db *, const uschar *, int *);
17 void    *dbfn_read_enforce_length(open_db *, const uschar *, size_t);
18 uschar  *dbfn_scan(open_db *, BOOL, EXIM_CURSOR **);
19 int      dbfn_write(open_db *, const uschar *, void *, int);
20
21 /* Macro for the common call to read without wanting to know the length. */
22
23 #define  dbfn_read(a, b) dbfn_read_with_length(a, b, NULL)
24
25 /* Berkeley DB uses a callback function to pass back error details. Its API
26 changed at release 4.3. */
27
28 #if defined(USE_DB) && defined(DB_VERSION_STRING)
29 # if DB_VERSION_MAJOR > 4 || (DB_VERSION_MAJOR == 4 && DB_VERSION_MINOR >= 3)
30 void     dbfn_bdb_error_callback(const DB_ENV *, const char *, const char *);
31 # else
32 void     dbfn_bdb_error_callback(const char *, char *);
33 # endif
34 #endif
35
36 #endif
37 /* End of dbfunctions.h */