Mercurial > hg > xemacs-beta

comparison man/lispref/databases.texi @ 444:576fb035e263 r21-2-37

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Import from CVS: tag r21-2-37
author cvs
date Mon, 13 Aug 2007 11:36:19 +0200
parents abe6d1db359e
children 9fae6227ede5
comparison
equal deleted inserted replaced
443:a8296e22da4e 444:576fb035e263
33 For a @var{type} of @code{'dbm}, there are no subtypes, so 33 For a @var{type} of @code{'dbm}, there are no subtypes, so
34 @var{subtype} should be @code{nil}. 34 @var{subtype} should be @code{nil}.
35 35
36 For a @var{type} of @code{'berkeley-db}, the following subtypes are 36 For a @var{type} of @code{'berkeley-db}, the following subtypes are
37 available: @code{'hash}, @code{'btree}, and @code{'recno}. See the 37 available: @code{'hash}, @code{'btree}, and @code{'recno}. See the
38 manpages for the Berkeley DB functions for more information about these 38 manpages for the Berkeley DB functions for more information about these
39 types. 39 types.
40 @end defun 40 @end defun
41 41
42 @defun close-database obj 42 @defun close-database database
43 This function closes database @var{obj}. 43 This function closes database @var{database}.
44 @end defun 44 @end defun
45 45
46 @defun database-live-p obj 46 @defun database-live-p object
47 This function returns @code{t} iff @var{obj} is an active database, else 47 This function returns @code{t} if @var{object} is an active database, else
48 @code{nil}. 48 @code{nil}.
49 @end defun 49 @end defun
50 50
51 @node Working With a Database 51 @node Working With a Database
52 @section Working With a Database 52 @section Working With a Database
53 53
54 @defun get-database key dbase &optional default 54 @defun get-database key database &optional default
55 This function finds the value for @var{key} in @var{database}. If there is no 55 This function finds the value for @var{key} in @var{database}. If there is no
56 corresponding value, @var{default} is returned (@code{nil} if @var{default} is 56 corresponding value, @var{default} is returned (@code{nil} if @var{default} is
57 omitted). 57 omitted).
58 @end defun 58 @end defun
59 59
60 @defun map-database function dbase 60 @defun map-database function database
61 This function maps @var{function} over entries in @var{database}, 61 This function maps @var{function} over entries in @var{database},
62 calling it with two args, each key and value in the database. 62 calling it with two args, each key and value in the database.
63 @end defun 63 @end defun
64 64
65 @defun put-database key val dbase &optional replace 65 @defun put-database key value database &optional replace
66 This function stores @var{key} and @var{val} in @var{database}. If 66 This function stores @var{key} and @var{value} in @var{database}.
67 optional fourth arg @var{replace} is non-@code{nil}, replace any 67 If optional fourth arg @var{replace} is non-@code{nil}, replace any
68 existing entry in the database. 68 existing entry in the database.
69 @end defun 69 @end defun
70 70
71 @defun remove-database key dbase 71 @defun remove-database key database
72 This function removes @var{key} from @var{database}. 72 This function removes @var{key} from @var{database}.
73 @end defun 73 @end defun
74 74
75 @node Other Database Functions 75 @node Other Database Functions
76 @section Other Database Functions 76 @section Other Database Functions
77 77
78 @defun database-file-name obj 78 @defun database-file-name database
79 This function returns the filename associated with the database @var{obj}. 79 This function returns the filename associated with @var{database}.
80 @end defun 80 @end defun
81 81
82 @defun database-last-error &optional obj 82 @defun database-last-error &optional database
83 This function returns the last error associated with database @var{obj}. 83 This function returns the last error associated with @var{database}.
84 @end defun 84 @end defun
85 85
86 @defun database-subtype obj 86 @defun database-subtype database
87 This function returns the subtype of database @var{obj}, if any. 87 This function returns the subtype of @var{database}, if any.
88 @end defun 88 @end defun
89 89
90 @defun database-type obj 90 @defun database-type database
91 This function returns the type of database @var{obj}. 91 This function returns the type of @var{database}.
92 @end defun 92 @end defun