freebsd-skq/lib/libc/stdlib/lsearch.3

.\"
.\" Initial implementation:
.\" Copyright (c) 2002 Robert Drehmel
.\" All rights reserved.
.\"
.\" As long as the above copyright statement and this notice remain
.\" unchanged, you can do what ever you want with this file.
.\"
.\" $FreeBSD$
.\"
.Dd October 11, 2002
.Dt LSEARCH 3
.Os
.Sh NAME
.Nm lsearch ,
.Nm lfind
.Nd linear search and append
.Sh LIBRARY
.Lb libc
.Sh SYNOPSIS
.In search.h
.Ft "void *"
.Fo lsearch
.Fa "const void *key" "void *base" "size_t *nelp" "size_t width"
.Fa "int \*[lp]*compar\*[rp]\*[lp]const void *, const void *\*[rp]"
.Fc
.Ft "void *"
.Fo lfind
.Fa "const void *key" "const void *base" "size_t *nelp" "size_t width"
.Fa "int \*[lp]*compar\*[rp]\*[lp]const void *, const void *\*[rp]"
.Fc
.Sh DESCRIPTION
The
.Fn lsearch
and
.Fn lfind
functions walk linearly through an array and compare each element with
the one to be sought using a supplied comparison function.
.Pp
.Fa key
points to an element that matches the one that is searched.
The array's address in memory is denoted by the
.Fa base
argument.
The width of one element (i.e., the size as returned by
.Fn sizeof )
is passed as the
.Fa width
argument.
The number of valid elements contained in the array (not the number of
elements the array has space reserved for) is given in the integer pointed
to by
.Fa nelp .
The
.Fa compar
argument points to a function which compares its two arguments and returns
zero if they are matching, and non-zero otherwise.
.Pp
If no matching element was found in the array,
.Fn lsearch
copies
.Fa key
into the position after the last element and increments the
integer pointed to by
.Fa nelp .
.Sh RETURN VALUES
The
.Fn lsearch
and
.Fn lfind
functions
return a pointer to the first element found.
If no element was found,
.Fn lsearch
returns a pointer to the newly added element, whereas
.Fn lfind
returns
.Dv NULL .
Both functions return
.Dv NULL
if an error occurs.
.Sh SEE ALSO
.Xr bsearch 3 ,
.Xr hsearch 3 ,
.Xr tsearch 3
.Sh HISTORY
The
.Fn lsearch
and
.Fn lfind
functions appeared in
.Bx 4.2 .
In
.Fx 5.0 ,
they reappeared conforming to
.St -p1003.1-2001 .
.Sh STANDARDS
The
.Fn lsearch
and
.Fn lfind
functions conform to
.St -p1003.1-2001 .
- Remove the lsearch() and lfind() functions and their manpage from the compatibility library libcompat. - Add new implementations of lsearch() and lfind() which conform to IEEE Std 1003.1-2001 to libc. Add a new manual page for them and add them to the makefile. - Add function prototypes for lsearch() and lfind() to the search.h header. 2002-10-16 14:29:23 +00:00			`.\"`
			`.\" Initial implementation:`
			`.\" Copyright (c) 2002 Robert Drehmel`
			`.\" All rights reserved.`
			`.\"`
			`.\" As long as the above copyright statement and this notice remain`
mdoc(7) police: nits. Approved by: re 2002-12-09 13:14:15 +00:00			`.\" unchanged, you can do what ever you want with this file.`
- Remove the lsearch() and lfind() functions and their manpage from the compatibility library libcompat. - Add new implementations of lsearch() and lfind() which conform to IEEE Std 1003.1-2001 to libc. Add a new manual page for them and add them to the makefile. - Add function prototypes for lsearch() and lfind() to the search.h header. 2002-10-16 14:29:23 +00:00			`.\"`
			`.\" $FreeBSD$`
			`.\"`
			`.Dd October 11, 2002`
			`.Dt LSEARCH 3`
			`.Os`
			`.Sh NAME`
			`.Nm lsearch ,`
			`.Nm lfind`
			`.Nd linear search and append`
			`.Sh LIBRARY`
			`.Lb libc`
			`.Sh SYNOPSIS`
			`.In search.h`
mdoc(7) police: nits. Approved by: re 2002-12-09 13:14:15 +00:00			`.Ft "void *"`
			`.Fo lsearch`
			`.Fa "const void key" "void base" "size_t *nelp" "size_t width"`
			`.Fa "int \[lp]compar\[rp]\[lp]const void , const void \*[rp]"`
			`.Fc`
			`.Ft "void *"`
			`.Fo lfind`
			`.Fa "const void key" "const void base" "size_t *nelp" "size_t width"`
			`.Fa "int \[lp]compar\[rp]\[lp]const void , const void \*[rp]"`
			`.Fc`
- Remove the lsearch() and lfind() functions and their manpage from the compatibility library libcompat. - Add new implementations of lsearch() and lfind() which conform to IEEE Std 1003.1-2001 to libc. Add a new manual page for them and add them to the makefile. - Add function prototypes for lsearch() and lfind() to the search.h header. 2002-10-16 14:29:23 +00:00			`.Sh DESCRIPTION`
			`The`
			`.Fn lsearch`
			`and`
			`.Fn lfind`
			`functions walk linearly through an array and compare each element with`
			`the one to be sought using a supplied comparison function.`
			`.Pp`
			`.Fa key`
			`points to an element that matches the one that is searched.`
mdoc(7) police: nits. Approved by: re 2002-12-09 13:14:15 +00:00			`The array's address in memory is denoted by the`
- Remove the lsearch() and lfind() functions and their manpage from the compatibility library libcompat. - Add new implementations of lsearch() and lfind() which conform to IEEE Std 1003.1-2001 to libc. Add a new manual page for them and add them to the makefile. - Add function prototypes for lsearch() and lfind() to the search.h header. 2002-10-16 14:29:23 +00:00			`.Fa base`
			`argument.`
mdoc(7) police: nits. Approved by: re 2002-12-09 13:14:15 +00:00			`The width of one element (i.e., the size as returned by`
- Remove the lsearch() and lfind() functions and their manpage from the compatibility library libcompat. - Add new implementations of lsearch() and lfind() which conform to IEEE Std 1003.1-2001 to libc. Add a new manual page for them and add them to the makefile. - Add function prototypes for lsearch() and lfind() to the search.h header. 2002-10-16 14:29:23 +00:00			`.Fn sizeof )`
mdoc(7) police: nits. Approved by: re 2002-12-09 13:14:15 +00:00			`is passed as the`
			`.Fa width`
- Remove the lsearch() and lfind() functions and their manpage from the compatibility library libcompat. - Add new implementations of lsearch() and lfind() which conform to IEEE Std 1003.1-2001 to libc. Add a new manual page for them and add them to the makefile. - Add function prototypes for lsearch() and lfind() to the search.h header. 2002-10-16 14:29:23 +00:00			`argument.`
			`The number of valid elements contained in the array (not the number of`
			`elements the array has space reserved for) is given in the integer pointed`
			`to by`
			`.Fa nelp .`
			`The`
			`.Fa compar`
			`argument points to a function which compares its two arguments and returns`
mdoc(7) police: nits. Approved by: re 2002-12-09 13:14:15 +00:00			`zero if they are matching, and non-zero otherwise.`
- Remove the lsearch() and lfind() functions and their manpage from the compatibility library libcompat. - Add new implementations of lsearch() and lfind() which conform to IEEE Std 1003.1-2001 to libc. Add a new manual page for them and add them to the makefile. - Add function prototypes for lsearch() and lfind() to the search.h header. 2002-10-16 14:29:23 +00:00			`.Pp`
mdoc(7) police: nits. Approved by: re 2002-12-09 13:14:15 +00:00			`If no matching element was found in the array,`
			`.Fn lsearch`
- Remove the lsearch() and lfind() functions and their manpage from the compatibility library libcompat. - Add new implementations of lsearch() and lfind() which conform to IEEE Std 1003.1-2001 to libc. Add a new manual page for them and add them to the makefile. - Add function prototypes for lsearch() and lfind() to the search.h header. 2002-10-16 14:29:23 +00:00			`copies`
			`.Fa key`
			`into the position after the last element and increments the`
			`integer pointed to by`
			`.Fa nelp .`
			`.Sh RETURN VALUES`
mdoc(7) police: "The .Fn function". 2002-12-18 12:45:11 +00:00			`The`
- Remove the lsearch() and lfind() functions and their manpage from the compatibility library libcompat. - Add new implementations of lsearch() and lfind() which conform to IEEE Std 1003.1-2001 to libc. Add a new manual page for them and add them to the makefile. - Add function prototypes for lsearch() and lfind() to the search.h header. 2002-10-16 14:29:23 +00:00			`.Fn lsearch`
			`and`
			`.Fn lfind`
mdoc(7) police: "The .Fn function". 2002-12-18 12:45:11 +00:00			`functions`
- Remove the lsearch() and lfind() functions and their manpage from the compatibility library libcompat. - Add new implementations of lsearch() and lfind() which conform to IEEE Std 1003.1-2001 to libc. Add a new manual page for them and add them to the makefile. - Add function prototypes for lsearch() and lfind() to the search.h header. 2002-10-16 14:29:23 +00:00			`return a pointer to the first element found.`
			`If no element was found,`
			`.Fn lsearch`
			`returns a pointer to the newly added element, whereas`
			`.Fn lfind`
			`returns`
			`.Dv NULL .`
			`Both functions return`
			`.Dv NULL`
			`if an error occurs.`
			`.Sh SEE ALSO`
			`.Xr bsearch 3 ,`
			`.Xr hsearch 3 ,`
			`.Xr tsearch 3`
			`.Sh HISTORY`
			`The`
			`.Fn lsearch`
			`and`
			`.Fn lfind`
			`functions appeared in`
			`.Bx 4.2 .`
			`In`
			`.Fx 5.0 ,`
			`they reappeared conforming to`
			`.St -p1003.1-2001 .`
			`.Sh STANDARDS`
			`The`
			`.Fn lsearch`
			`and`
			`.Fn lfind`
			`functions conform to`
			`.St -p1003.1-2001 .`