Manual page for hcreate(3) and friends.
This commit is contained in:
kleink
parent
718a724b1c
commit
cbab327fc8
@ -1,11 +1,13 @@
|
||||
# $NetBSD: Makefile.inc,v 1.6 1997/09/24 07:33:49 fair Exp $
|
||||
# $NetBSD: Makefile.inc,v 1.7 1999/03/08 18:43:21 kleink Exp $
|
||||
# @(#)Makefile.inc 8.1 (Berkeley) 6/4/93
|
||||
|
||||
.PATH: ${.CURDIR}/db/man
|
||||
|
||||
# mpool.3
|
||||
MAN+= btree.3 dbopen.3 hash.3 recno.3 mpool.3
|
||||
MAN+= btree.3 dbopen.3 hash.3 hcreate.3 recno.3 mpool.3
|
||||
MLINKS+= dbopen.3 db.3
|
||||
MLINKS+= hcreate.3 hdestroy.3
|
||||
MLINKS+= hcreate.3 hsearch.3
|
||||
MLINKS+= mpool.3 mpool_open.3 mpool.3 mpool_filter.3 mpool.3 mpool_new.3
|
||||
MLINKS+= mpool.3 mpool_get.3 mpool.3 mpool_put.3 mpool.3 mpool_sync.3
|
||||
MLINKS+= mpool.3 mpool_close.3
|
||||
|
||||
188
lib/libc/db/man/hcreate.3
Normal file
188
lib/libc/db/man/hcreate.3
Normal file
@ -0,0 +1,188 @@
|
||||
.\" $NetBSD: hcreate.3,v 1.1 1999/03/08 18:43:21 kleink Exp $
|
||||
.\"
|
||||
.\" Copyright (c) 1999 The NetBSD Foundation, Inc.
|
||||
.\" All rights reserved.
|
||||
.\"
|
||||
.\" This code is derived from software contributed to The NetBSD Foundation
|
||||
.\" by Klaus Klein.
|
||||
.\"
|
||||
.\" Redistribution and use in source and binary forms, with or without
|
||||
.\" modification, are permitted provided that the following conditions
|
||||
.\" are met:
|
||||
.\" 1. Redistributions of source code must retain the above copyright
|
||||
.\" notice, this list of conditions and the following disclaimer.
|
||||
.\" 2. Redistributions in binary form must reproduce the above copyright
|
||||
.\" notice, this list of conditions and the following disclaimer in the
|
||||
.\" documentation and/or other materials provided with the distribution.
|
||||
.\" 3. All advertising materials mentioning features or use of this software
|
||||
.\" must display the following acknowledgement:
|
||||
.\" This product includes software developed by the NetBSD
|
||||
.\" Foundation, Inc. and its contributors.
|
||||
.\" 4. Neither the name of The NetBSD Foundation nor the names of its
|
||||
.\" contributors may be used to endorse or promote products derived
|
||||
.\" from this software without specific prior written permission.
|
||||
.\"
|
||||
.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
|
||||
.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
|
||||
.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||
.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
|
||||
.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
|
||||
.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
|
||||
.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
|
||||
.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
|
||||
.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
|
||||
.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
|
||||
.\" POSSIBILITY OF SUCH DAMAGE.
|
||||
.\"
|
||||
.Dd February 16, 1999
|
||||
.Dt HCREATE 3
|
||||
.Os NetBSD
|
||||
.Sh NAME
|
||||
.Nm hcreate ,
|
||||
.Nm hdestroy ,
|
||||
.Nm hsearch
|
||||
.Nd manage hash search table
|
||||
.Sh LIBRARY
|
||||
.Lb libc
|
||||
.Sh SYNOPSIS
|
||||
.Fd #include <search.h>
|
||||
.Ft int
|
||||
.Fn hcreate "size_t nel"
|
||||
.Ft void
|
||||
.Fn hdestroy "void"
|
||||
.Ft ENTRY *
|
||||
.Fn hsearch "ENTRY item" "ACTION action"
|
||||
.Sh DESCRIPTION
|
||||
The
|
||||
.Fn hcreate ,
|
||||
.Fn hdestroy
|
||||
and
|
||||
.Fn hsearch
|
||||
functions manage hash search tables.
|
||||
.Pp
|
||||
The
|
||||
.Fn hcreate
|
||||
function allocates and initializes the table.
|
||||
The
|
||||
.Fa nel
|
||||
argument specifies an estimate of the maximum number of entries to be held
|
||||
by the table. Unless further memory allocation fails, supplying an
|
||||
insufficient
|
||||
.Fa nel
|
||||
value will not result in functional harm, although a performance degradation
|
||||
may occur.
|
||||
Initialization using the
|
||||
.Fn hcreate
|
||||
function is mandatory prior to any access operations using
|
||||
.Fn hsearch .
|
||||
.Pp
|
||||
The
|
||||
.Fn hdestroy
|
||||
function destroys a table previously created using
|
||||
.Fn hcreate .
|
||||
After a call to
|
||||
.Fn hdestroy ,
|
||||
the data can no longer be accessed.
|
||||
.Pp
|
||||
The
|
||||
.Fn hsearch
|
||||
function is used to search to the hash table. It returns a pointer into the
|
||||
hash table indicating the address of an item. The
|
||||
.Fa item
|
||||
argument is of type
|
||||
.Dv ENTRY ,
|
||||
a structural type which contains the following members:
|
||||
.Bl -tag -compact -offset indent -width voidX*dataXX
|
||||
.It Fa char *key
|
||||
comparison key.
|
||||
.It Fa void *data
|
||||
pointer to data associated with
|
||||
.Fa key .
|
||||
.El
|
||||
.Pp
|
||||
The key comparison function used by
|
||||
.Fn hsearch
|
||||
is
|
||||
.Xr strcmp 3 .
|
||||
.Pp
|
||||
The
|
||||
.Fa action
|
||||
argument is of type
|
||||
.Dv ACTION ,
|
||||
an enumeration type which defines the following values:
|
||||
.Bl -tag -compact -offset indent -width ENTERXX
|
||||
.It Dv ENTER
|
||||
insert
|
||||
.Fa item
|
||||
into the hash table, possibly replacing an existing item.
|
||||
.It Dv FIND
|
||||
search the hash table without inserting
|
||||
.Fa item .
|
||||
Unsuccessful resolution is indicated by the return of a
|
||||
.Dv NULL
|
||||
pointer.
|
||||
.El
|
||||
.Pp
|
||||
.Sh RETURN VALUES
|
||||
If successful, the
|
||||
.Fn hcreate
|
||||
function returns a non-zero value. Otherwise, a value of 0 is returned and
|
||||
.Va errno
|
||||
is set to indicate the error.
|
||||
.Pp
|
||||
The
|
||||
.Fn hdestroy
|
||||
functions
|
||||
returns no value.
|
||||
.Pp
|
||||
If successful, the
|
||||
.Fn hsearch
|
||||
function returns a pointer to the item.
|
||||
If the action is
|
||||
.Dv FIND
|
||||
and the item was not found, or if the action is
|
||||
.Dv ENTER
|
||||
and the insertion failed,
|
||||
.Dv NULL
|
||||
is returned and
|
||||
.Va errno
|
||||
is set to indicate the error.
|
||||
.Sh ERRORS
|
||||
The
|
||||
.Fn hcreate
|
||||
and
|
||||
.Fn hsearch
|
||||
functions will fail if:
|
||||
.Bl -tag -width Er
|
||||
.It Bq Er ENOMEM
|
||||
Insufficient memory is available.
|
||||
.Sh SEE ALSO
|
||||
.Xr bsearch 3 ,
|
||||
.Xr lsearch 3 ,
|
||||
.Xr malloc 3 ,
|
||||
.Xr strcmp 3
|
||||
.Sh STANDARDS
|
||||
The
|
||||
.Fn hcreate ,
|
||||
.Fn hdestroy
|
||||
and
|
||||
.Fn hsearch
|
||||
functions conform to
|
||||
.St -xpg4.2 .
|
||||
.Sh BUGS
|
||||
The
|
||||
.Fn hsearch
|
||||
function currently returns a pointer into a static buffer area; subsequent
|
||||
calls to
|
||||
.Fn hsearch
|
||||
may overwrite this buffer.
|
||||
.Pp
|
||||
The interface permits the use of only one hash table at a time.
|
||||
.Sh HISTORY
|
||||
The
|
||||
.Fn hcreate ,
|
||||
.Fn hdestroy
|
||||
and
|
||||
.Fn hsearch
|
||||
functions first appeared in
|
||||
.At V .
|
||||
Loading…
Reference in New Issue
Block a user