summaryrefslogtreecommitdiff
path: root/support/dktools/dk4dbia.h
blob: a3a834b9ce284f24d27815afca2caae6de86c7d6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
/*
Copyright (C) 2015-2020, Dirk Krause
SPDX-License-Identifier: BSD-3-Clause
*/

/*
	WARNING: This file was generated by the dkct program (see
	http://dktools.sourceforge.net/ for details).
	Changes you make here will be lost if dkct is run again!
	You should modify the original source and run dkct on it.
	Original source: dk4dbia.ctr
*/

/**	@file dk4dbia.h Header file for the dk4dbia module.
*/

#ifndef DK4DBIA_H_INCLUDED
/** Avoid multiple inclusions. */
#define DK4DBIA_H_INCLUDED 1


#line 10 "dk4dbia.ctr"

#ifndef	DK4CONF_H_INCLUDED
#if DK4_BUILDING_DKTOOLS4
#include "dk4conf.h"
#else
#include <dktools-4/dk4conf.h>
#endif
#endif

#ifndef DK4DBI_H_INCLUDED
#if DK4_BUILDING_DKTOOLS4
#include "dk4dbi.h"
#else
#include <dktools-4/dk4dbi.h>
#endif
#endif

#ifndef DK4APP_H_INCLUDED
#if DK4_BUILDING_DKTOOLS4
#include "dk4app.h"
#else
#include <dktools-4/dk4app.h>
#endif
#endif


#ifdef	__cplusplus
extern "C" {
#endif


/**	Open database.
	@param	fn	Database type and file name.
			The database type is one from "mem", "bdb" or "ndbm".
			Database type and file name are separated by two
			colons "::".
	@param	wa	Flag: Write access required.
	@param	tr	Flag: Truncate existing database (only in conjunction
			with wa).
	@param	erp	Error report, may be NULL.
	@param	app	Application structure for diagnostics, may be NULL.
	@return	Pointer to new database structure on success, NULL on error.

	Error codes:
	- DK4_E_INVALID_ARGUMENTS<br>
	  if fn is NULL or tp contains an invalid type number,
	- DK4_E_NOT_SUPPORTED<br>
	  if the database type is not supported,
	- DK4_E_MATH_OVERFLOW<br>
	  on numeric overflow when calculating size,
	- DK4_E_MEMORY_ALLOCATION_FAILED<br>
	  with mem.elsize and mem.nelem
	  set if there is not enough memory available,
	- DK4_E_SYNTAX<br>
	  if
	  - the specification contains an invalid backend type
	  - the database file name does not refer to a regular file
	  - or the file contents is not an in-memory database
	  - or key/value sizes in the file are in conflict with
	    size restrictions
	  - or an invalid database type was specified,
	- DK4_E_SEC_CHECK<br>
	  with failed check id in iDetails1 if access is denied by additional
	  security checks,
	- DK4_E_MEMORY_ALLOCATION_FAILED<br>
	  with mem.elsize and mem.nelem
	  set if there is not enough memory available,
	- DK4_E_OPEN_READ_FAILED<br>
	  if fopen() or fread() failed,
	- DK4_E_OPEN_WRITE_FAILED<br>
	  if fopen() or fwrite() failed,
	- DK4_E_CLOSE_FAILED<br>
	  with errno value in iDetails1 if fclose() failed.
*/
dk4_dbi_t *
dk4dbi_open_app(
  const dkChar	*fn,
  int		 wa,
  int		 tr,
  dk4_er_t	*erp,
  dk4_app_t	*app
);

/**	Open database.
	@param	fn	Database type and file name.
			The database type is one from "mem", "bdb" or "ndbm".
			Database type and file name are separated by two
			colons "::".
	@param	wa	Flag: Write access required.
	@param	tr	Flag: Truncate existing database (only in conjunction
			with wa).
	@param	km	Maximum key size.
	@param	vm	Maximum value size.
	@param	erp	Error report, may be NULL.
	@param	app	Application structure for diagnostics, may be NULL.
	@return	Pointer to new database structure on success, NULL on error.

	Error codes:
	- DK4_E_INVALID_ARGUMENTS<br>
	  if fn is NULL or tp contains an invalid type number,
	- DK4_E_NOT_SUPPORTED<br>
	  if the database type is not supported,
	- DK4_E_MATH_OVERFLOW<br>
	  on numeric overflow when calculating size,
	- DK4_E_MEMORY_ALLOCATION_FAILED<br>
	  with mem.elsize and mem.nelem
	  set if there is not enough memory available,
	- DK4_E_SYNTAX<br>
	  if
	  - the specification contains an invalid backend type
	  - the database file name does not refer to a regular file
	  - or the file contents is not an in-memory database
	  - or key/value sizes in the file are in conflict with
	    size restrictions
	  - or an invalid database type was specified,
	- DK4_E_SEC_CHECK<br>
	  with failed check id in iDetails1 if access is denied by additional
	  security checks,
	- DK4_E_MEMORY_ALLOCATION_FAILED<br>
	  with mem.elsize and mem.nelem
	  set if there is not enough memory available,
	- DK4_E_OPEN_READ_FAILED<br>
	  if fopen() or fread() failed,
	- DK4_E_OPEN_WRITE_FAILED<br>
	  if fopen() or fwrite() failed,
	- DK4_E_CLOSE_FAILED<br>
	  with errno value in iDetails1 if fclose() failed.
*/
dk4_dbi_t *
dk4dbi_open_sizes_app(
  const dkChar	*fn,
  int		 wa,
  int		 tr,
  size_t	 km,
  size_t	 vm,
  dk4_er_t	*erp,
  dk4_app_t	*app
);

#ifdef	__cplusplus
}
#endif



#endif