Blame man3/lsearch.3

Packit 7cfc04
.\" Copyright 1995 Jim Van Zandt <jrv@vanzandt.mv.com>
Packit 7cfc04
.\"
Packit 7cfc04
.\" %%%LICENSE_START(VERBATIM)
Packit 7cfc04
.\" Permission is granted to make and distribute verbatim copies of this
Packit 7cfc04
.\" manual provided the copyright notice and this permission notice are
Packit 7cfc04
.\" preserved on all copies.
Packit 7cfc04
.\"
Packit 7cfc04
.\" Permission is granted to copy and distribute modified versions of this
Packit 7cfc04
.\" manual under the conditions for verbatim copying, provided that the
Packit 7cfc04
.\" entire resulting derived work is distributed under the terms of a
Packit 7cfc04
.\" permission notice identical to this one.
Packit 7cfc04
.\"
Packit 7cfc04
.\" Since the Linux kernel and libraries are constantly changing, this
Packit 7cfc04
.\" manual page may be incorrect or out-of-date.  The author(s) assume no
Packit 7cfc04
.\" responsibility for errors or omissions, or for damages resulting from
Packit 7cfc04
.\" the use of the information contained herein.  The author(s) may not
Packit 7cfc04
.\" have taken the same level of care in the production of this manual,
Packit 7cfc04
.\" which is licensed free of charge, as they might when working
Packit 7cfc04
.\" professionally.
Packit 7cfc04
.\"
Packit 7cfc04
.\" Formatted or processed versions of this manual, if unaccompanied by
Packit 7cfc04
.\" the source, must acknowledge the copyright and authors of this work.
Packit 7cfc04
.\" %%%LICENSE_END
Packit 7cfc04
.\"
Packit 7cfc04
.\" Corrected prototype and include, aeb, 990927
Packit 7cfc04
.TH LSEARCH 3  2017-09-15 "GNU" "Linux Programmer's Manual"
Packit 7cfc04
.SH NAME
Packit 7cfc04
lfind, lsearch \- linear search of an array
Packit 7cfc04
.SH SYNOPSIS
Packit 7cfc04
.nf
Packit 7cfc04
.B #include <search.h>
Packit 7cfc04
.PP
Packit 7cfc04
.BI "void *lfind(const void *" key ", const void *" base ", size_t *" nmemb ,
Packit 7cfc04
.BI "         size_t " size ", int(*" compar ")(const void *, const void *));"
Packit 7cfc04
.PP
Packit 7cfc04
.BI "void *lsearch(const void *" key ", void *" base ", size_t *" nmemb ,
Packit 7cfc04
.BI "         size_t " size ", int(*" compar ")(const void *, const void *));"
Packit 7cfc04
.fi
Packit 7cfc04
.SH DESCRIPTION
Packit 7cfc04
.BR lfind ()
Packit 7cfc04
and
Packit 7cfc04
.BR lsearch ()
Packit 7cfc04
perform a linear search for
Packit 7cfc04
.I key
Packit 7cfc04
in the array
Packit 7cfc04
.IR base
Packit 7cfc04
which has
Packit 7cfc04
.I *nmemb
Packit 7cfc04
elements of
Packit 7cfc04
.I size
Packit 7cfc04
bytes each.
Packit 7cfc04
The comparison function referenced by
Packit 7cfc04
.I compar
Packit 7cfc04
is expected to have two arguments which point to the
Packit 7cfc04
.I key
Packit 7cfc04
object and to an array member, in that order, and which
Packit 7cfc04
returns zero if the
Packit 7cfc04
.I key
Packit 7cfc04
object matches the array member, and
Packit 7cfc04
nonzero otherwise.
Packit 7cfc04
.PP
Packit 7cfc04
If
Packit 7cfc04
.BR lsearch ()
Packit 7cfc04
does not find a matching element, then the
Packit 7cfc04
.I key
Packit 7cfc04
object is inserted at the end of the table, and
Packit 7cfc04
.I *nmemb
Packit 7cfc04
is
Packit 7cfc04
incremented.
Packit 7cfc04
In particular, one should know that a matching element
Packit 7cfc04
exists, or that more room is available.
Packit 7cfc04
.SH RETURN VALUE
Packit 7cfc04
.BR lfind ()
Packit 7cfc04
returns a pointer to a matching member of the array, or
Packit 7cfc04
NULL if no match is found.
Packit 7cfc04
.BR lsearch ()
Packit 7cfc04
returns a pointer to
Packit 7cfc04
a matching member of the array, or to the newly added member if no
Packit 7cfc04
match is found.
Packit 7cfc04
.SH ATTRIBUTES
Packit 7cfc04
For an explanation of the terms used in this section, see
Packit 7cfc04
.BR attributes (7).
Packit 7cfc04
.TS
Packit 7cfc04
allbox;
Packit 7cfc04
lbw18 lb lb
Packit 7cfc04
l l l.
Packit 7cfc04
Interface	Attribute	Value
Packit 7cfc04
T{
Packit 7cfc04
.BR lfind (),
Packit 7cfc04
.BR lsearch ()
Packit 7cfc04
T}	Thread safety	MT-Safe
Packit 7cfc04
.TE
Packit 7cfc04
.sp 1
Packit 7cfc04
.SH CONFORMING TO
Packit 7cfc04
POSIX.1-2001, POSIX.1-2008, SVr4, 4.3BSD.
Packit 7cfc04
Present in libc since libc-4.6.27.
Packit 7cfc04
.SH BUGS
Packit 7cfc04
The naming is unfortunate.
Packit 7cfc04
.SH SEE ALSO
Packit 7cfc04
.BR bsearch (3),
Packit 7cfc04
.BR hsearch (3),
Packit 7cfc04
.BR tsearch (3)
Packit 7cfc04
.SH COLOPHON
Packit 7cfc04
This page is part of release 4.15 of the Linux
Packit 7cfc04
.I man-pages
Packit 7cfc04
project.
Packit 7cfc04
A description of the project,
Packit 7cfc04
information about reporting bugs,
Packit 7cfc04
and the latest version of this page,
Packit 7cfc04
can be found at
Packit 7cfc04
\%https://www.kernel.org/doc/man\-pages/.