summaryrefslogtreecommitdiffabout
path: root/doc
authorSergey Poznyakoff <gray@gnu.org.ua>2016-07-08 12:25:25 (GMT)
committer Sergey Poznyakoff <gray@gnu.org.ua>2016-07-08 12:35:13 (GMT)
commit27b5d96eec6d43eed834c9f1492b1f3d38bf60ec (patch) (side-by-side diff)
treeac20224e957ad7688ec31d03e6080c09ab9fc4c9 /doc
parent4aef6b36f862e46723403bc6422ac47058a5ef19 (diff)
downloadgdbm-27b5d96eec6d43eed834c9f1492b1f3d38bf60ec.tar.gz
gdbm-27b5d96eec6d43eed834c9f1492b1f3d38bf60ec.tar.bz2
Improve _gdbm_findkey interface.
* doc/gdbm.texi: Document gdbm_exists in detail. * src/findkey.c (_gdbm_findkey): return parameters can be NULL. * src/gdbmexists.c (gdbm_exists): Remove unnecessary local variables. Reset gdbm_errno to 0 if the key was not found. * src/gdbmdelete.c (gdbm_delete): Remove unnecessary local variables. * src/gdbmfetch.c: Likewise. * src/gdbmseq.c: Likewise. * src/gdbmstore.c: Likewise.
Diffstat (limited to 'doc') (more/less context) (ignore whitespace changes)
-rw-r--r--doc/gdbm.texi10
1 files changed, 8 insertions, 2 deletions
diff --git a/doc/gdbm.texi b/doc/gdbm.texi
index 6fad9d9..4c7c5c0 100644
--- a/doc/gdbm.texi
+++ b/doc/gdbm.texi
@@ -464,8 +464,14 @@ else
You may also search for a particular key without retrieving it:
@deftypefn {gdbm interface} int gdbm_exists (GDBM_FILE @var{dbf}, datum @var{key})
-Returns @samp{true} (@samp{1}) if the @var{key} exists in @var{dbf}
-and @samp{false} (@samp{0}) otherwise.
+Checks whether the @var{key} exists in the database @var{dbf}.
+
+If @var{key} is found, returns @samp{true} (@samp{1}). If it is not
+found, returns @samp{false} (@samp{0}) and sets @code{gdbm_errno} to
+@samp{GDBM_NO_ERROR} (@samp{0}).
+
+On error, returns @samp{0} and sets @code{gdbm_errno} to a
+non-@samp{0} error code.
The parameters are:

Return to:

Send suggestions and report system problems to the System administrator.