man-pages/man3/lsearch.3.html
2021-03-31 01:06:50 +01:00

155 lines
3.7 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<HTML><HEAD><TITLE>Man page of LSEARCH</TITLE>
</HEAD><BODY>
<H1>LSEARCH</H1>
Section: Linux Programmer's Manual (3)<BR>Updated: 2017-09-15<BR><A HREF="#index">Index</A>
<A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>
<A NAME="lbAB">&nbsp;</A>
<H2>NAME</H2>
lfind, lsearch - linear search of an array
<A NAME="lbAC">&nbsp;</A>
<H2>SYNOPSIS</H2>
<PRE>
<B>#include &lt;<A HREF="file:///usr/include/search.h">search.h</A>&gt;</B>
<B>void *lfind(const void *</B><I>key</I><B>, const void *</B><I>base</I><B>, size_t *</B><I>nmemb</I><B>,</B>
<B> size_t </B><I>size</I><B>, int(*</B><I>compar</I><B>)(const void *, const void *));</B>
<B>void *lsearch(const void *</B><I>key</I><B>, void *</B><I>base</I><B>, size_t *</B><I>nmemb</I><B>,</B>
<B> size_t </B><I>size</I><B>, int(*</B><I>compar</I><B>)(const void *, const void *));</B>
</PRE>
<A NAME="lbAD">&nbsp;</A>
<H2>DESCRIPTION</H2>
<B>lfind</B>()
and
<B>lsearch</B>()
perform a linear search for
<I>key</I>
in the array
<I>base</I>
which has
<I>*nmemb</I>
elements of
<I>size</I>
bytes each.
The comparison function referenced by
<I>compar</I>
is expected to have two arguments which point to the
<I>key</I>
object and to an array member, in that order, and which
returns zero if the
<I>key</I>
object matches the array member, and
nonzero otherwise.
<P>
If
<B>lsearch</B>()
does not find a matching element, then the
<I>key</I>
object is inserted at the end of the table, and
<I>*nmemb</I>
is
incremented.
In particular, one should know that a matching element
exists, or that more room is available.
<A NAME="lbAE">&nbsp;</A>
<H2>RETURN VALUE</H2>
<B>lfind</B>()
returns a pointer to a matching member of the array, or
NULL if no match is found.
<B>lsearch</B>()
returns a pointer to
a matching member of the array, or to the newly added member if no
match is found.
<A NAME="lbAF">&nbsp;</A>
<H2>ATTRIBUTES</H2>
For an explanation of the terms used in this section, see
<B><A HREF="/cgi-bin/man/man2html?7+attributes">attributes</A></B>(7).
<TABLE BORDER>
<TR VALIGN=top><TD><B>Interface</B></TD><TD><B>Attribute</B></TD><TD><B>Value</B><BR></TD></TR>
<TR VALIGN=top><TD>
<B>lfind</B>(),
<B>lsearch</B>()
</TD><TD>Thread safety</TD><TD>MT-Safe<BR></TD></TR>
</TABLE>
<P>
<A NAME="lbAG">&nbsp;</A>
<H2>CONFORMING TO</H2>
POSIX.1-2001, POSIX.1-2008, SVr4, 4.3BSD.
Present in libc since libc-4.6.27.
<A NAME="lbAH">&nbsp;</A>
<H2>BUGS</H2>
The naming is unfortunate.
<A NAME="lbAI">&nbsp;</A>
<H2>SEE ALSO</H2>
<B><A HREF="/cgi-bin/man/man2html?3+bsearch">bsearch</A></B>(3),
<B><A HREF="/cgi-bin/man/man2html?3+hsearch">hsearch</A></B>(3),
<B><A HREF="/cgi-bin/man/man2html?3+tsearch">tsearch</A></B>(3)
<A NAME="lbAJ">&nbsp;</A>
<H2>COLOPHON</H2>
This page is part of release 5.05 of the Linux
<I>man-pages</I>
project.
A description of the project,
information about reporting bugs,
and the latest version of this page,
can be found at
<A HREF="https://www.kernel.org/doc/man-pages/.">https://www.kernel.org/doc/man-pages/.</A>
<P>
<HR>
<A NAME="index">&nbsp;</A><H2>Index</H2>
<DL>
<DT id="1"><A HREF="#lbAB">NAME</A><DD>
<DT id="2"><A HREF="#lbAC">SYNOPSIS</A><DD>
<DT id="3"><A HREF="#lbAD">DESCRIPTION</A><DD>
<DT id="4"><A HREF="#lbAE">RETURN VALUE</A><DD>
<DT id="5"><A HREF="#lbAF">ATTRIBUTES</A><DD>
<DT id="6"><A HREF="#lbAG">CONFORMING TO</A><DD>
<DT id="7"><A HREF="#lbAH">BUGS</A><DD>
<DT id="8"><A HREF="#lbAI">SEE ALSO</A><DD>
<DT id="9"><A HREF="#lbAJ">COLOPHON</A><DD>
</DL>
<HR>
This document was created by
<A HREF="/cgi-bin/man/man2html">man2html</A>,
using the manual pages.<BR>
Time: 00:05:47 GMT, March 31, 2021
</BODY>
</HTML>