1 .\" Copyright (c) 1999 Tim Singletary
2 .\" No copyright is claimed.
4 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
5 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
6 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
7 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
8 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
9 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
10 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
11 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
12 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
13 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
18 .\" Note: The date here should be updated whenever a non-trivial
19 .\" change is made to the manual page.
34 .Nd database access functions
39 .Fn dbm_open "const char *base" "int flags" "int mode"
41 .Fn dbm_close "DBM *db"
43 .Fn dbm_store "DBM *db" "datum key" "datum data" "int flags"
45 .Fn dbm_fetch "DBM *db" "datum key"
47 .Fn dbm_delete "DBM *db" "datum key"
49 .Fn dbm_firstkey "DBM *db"
51 .Fn dbm_nextkey "DBM *db"
53 .Fn dbm_error "DBM *db"
55 .Fn dbm_clearerr "DBM *db"
57 .Fn dbm_dirfno "DBM *db"
59 Database access functions.
60 These functions are implemented using
77 .Fn dbm_open base flags mode
79 opens or creates a database.
83 is the basename of the file containing
84 the database; the actual database has a
90 .Qq Li /home/me/mystuff
91 then the actual database is in the file
92 .Pa /home/me/mystuff.db .
100 .Pq Dv O_RDWR | O_CREAT
101 is a typical value for
104 is a typical value for
109 The pointer returned by
111 identifies the database and is the
113 argument to the other functions.
121 if there were any errors.
129 .Fn dbm_store db key data flags
131 inserts or replaces an entry in the database.
143 and the database already contains an entry for
145 that entry is not replaced.
146 Otherwise the entry is replaced or inserted.
150 normally returns zero but returns 1 if the entry could not be
157 already exists) or returns -1 and sets
159 if there were any errors.
172 .Fn dbm_delete db key
174 deletes the entry for
179 normally returns zero but returns 1 if there was no entry with
181 in the database or returns -1 and sets
183 if there were any errors.
188 returns the first key in the database.
192 returns subsequent keys.
196 must be called before
198 The order in which keys are returned is unspecified and may appear
205 after all keys have been returned.
212 value of the most recent error.
216 resets this value to 0 and returns 0.
221 returns the file descriptor to the database.
227 These functions (except