lsearch(3) — Linux manual page

lsearch(3)               Library Functions Manual              lsearch(3)

NAME         top

       lfind, lsearch - linear search of an array

LIBRARY         top

       Standard C library (libc, -lc)

SYNOPSIS         top

       #include <search.h>

       void *lfind(const void key[.size], const void base[*.n * .size],
                   size_t *n, size_t size,
                   typeof(int (const void [.size], const void [.size]))
                       *compar);
       void *lsearch(const void key[.size], void base[*.n * .size],
                   size_t *n, size_t size,
                   typeof(int (const void [.size], const void [.size]))
                       *compar);

DESCRIPTION         top

       lfind() and lsearch() perform a linear search for key in the array
       base which has *n elements of size bytes each.  The comparison
       function referenced by compar is expected to have two arguments
       which point to the key object and to an array member, in that
       order, and which returns zero if the key object matches the array
       member, and nonzero otherwise.

       If lsearch() does not find a matching element, then the key object
       is inserted at the end of the table, and *n is incremented.  In
       particular, one should know that a matching element exists, or
       that more room is available.

RETURN VALUE         top

       lfind() returns a pointer to a matching member of the array, or
       NULL if no match is found.  lsearch() returns a pointer to a
       matching member of the array, or to the newly added member if no
       match is found.

ATTRIBUTES         top

       For an explanation of the terms used in this section, see
       attributes(7).
       ┌──────────────────────────────────────┬───────────────┬─────────┐
       │ Interface                            │ Attribute     │ Value   │
       ├──────────────────────────────────────┼───────────────┼─────────┤
       │ lfind(), lsearch()                   │ Thread safety │ MT-Safe │
       └──────────────────────────────────────┴───────────────┴─────────┘

STANDARDS         top

       POSIX.1-2008.

HISTORY         top

       POSIX.1-2001, SVr4, 4.3BSD.  libc-4.6.27.

BUGS         top

       The naming is unfortunate.

SEE ALSO         top

       bsearch(3), hsearch(3), tsearch(3)

COLOPHON         top

       This page is part of the man-pages (Linux kernel and C library
       user-space interface documentation) project.  Information about
       the project can be found at 
       ⟨https://www.kernel.org/doc/man-pages/⟩.  If you have a bug report
       for this manual page, see
       ⟨https://git.kernel.org/pub/scm/docs/man-pages/man-pages.git/tree/CONTRIBUTING⟩.
       This page was obtained from the tarball man-pages-6.10.tar.gz
       fetched from
       ⟨https://mirrors.edge.kernel.org/pub/linux/docs/man-pages/⟩ on
       2025-02-02.  If you discover any rendering problems in this HTML
       version of the page, or you believe there is a better or more up-
       to-date source for the page, or you have corrections or
       improvements to the information in this COLOPHON (which is not
       part of the original manual page), send a mail to
       man-pages@man7.org

Linux man-pages 6.10            2024-12-13                     lsearch(3)

Pages that refer to this page: bsearch(3),  hsearch(3),  tsearch(3)

HTML rendering created 2025-02-02 by Michael Kerrisk, author of The Linux Programming Interface. For details of in-depth Linux/UNIX system programming training courses that I teach, look here. Hosting by jambit GmbH.