2004-11-03 13:51:07 +00:00
|
|
|
.\" Hey Emacs! This file is -*- nroff -*- source.
|
|
|
|
.\" Copyright 1995 Jim Van Zandt <jrv@vanzandt.mv.com>
|
|
|
|
.\"
|
|
|
|
.\" Permission is granted to make and distribute verbatim copies of this
|
|
|
|
.\" manual provided the copyright notice and this permission notice are
|
|
|
|
.\" preserved on all copies.
|
|
|
|
.\"
|
|
|
|
.\" Permission is granted to copy and distribute modified versions of this
|
|
|
|
.\" manual under the conditions for verbatim copying, provided that the
|
|
|
|
.\" entire resulting derived work is distributed under the terms of a
|
|
|
|
.\" permission notice identical to this one.
|
2007-04-12 22:42:49 +00:00
|
|
|
.\"
|
2004-11-03 13:51:07 +00:00
|
|
|
.\" Since the Linux kernel and libraries are constantly changing, this
|
|
|
|
.\" manual page may be incorrect or out-of-date. The author(s) assume no
|
|
|
|
.\" responsibility for errors or omissions, or for damages resulting from
|
|
|
|
.\" the use of the information contained herein. The author(s) may not
|
|
|
|
.\" have taken the same level of care in the production of this manual,
|
|
|
|
.\" which is licensed free of charge, as they might when working
|
|
|
|
.\" professionally.
|
2007-04-12 22:42:49 +00:00
|
|
|
.\"
|
2004-11-03 13:51:07 +00:00
|
|
|
.\" Formatted or processed versions of this manual, if unaccompanied by
|
|
|
|
.\" the source, must acknowledge the copyright and authors of this work.
|
|
|
|
.\"
|
|
|
|
.\" Corrected prototype and include, aeb, 990927
|
|
|
|
.TH LSEARCH 3 1999-09-27 "GNU" "Linux Programmer's Manual"
|
|
|
|
.SH NAME
|
|
|
|
lfind, lsearch \- linear search of an array
|
|
|
|
.SH SYNOPSIS
|
|
|
|
.nf
|
|
|
|
.B #include <search.h>
|
|
|
|
.sp
|
|
|
|
.BI "void *lfind(const void *" key ", const void *" base ", size_t *" nmemb ,
|
2007-12-23 08:20:39 +00:00
|
|
|
.BI " size_t " size ", int(*" compar ")(const void *, const void *));"
|
2004-11-03 13:51:07 +00:00
|
|
|
.sp
|
|
|
|
.BI "void *lsearch(const void *" key ", void *" base ", size_t *" nmemb ,
|
2007-12-23 08:20:39 +00:00
|
|
|
.BI " size_t " size ", int(*" compar ")(const void *, const void *));"
|
2004-11-03 13:51:07 +00:00
|
|
|
.fi
|
|
|
|
.SH DESCRIPTION
|
2007-05-12 09:06:04 +00:00
|
|
|
.BR lfind ()
|
|
|
|
and
|
|
|
|
.BR lsearch ()
|
|
|
|
perform a linear search for
|
2007-11-29 17:59:49 +00:00
|
|
|
\fIkey\fP in the array \fIbase\fP which has \fI*nmemb\fP elements of
|
2007-04-12 22:42:49 +00:00
|
|
|
\fIsize\fP bytes each.
|
|
|
|
The comparison function referenced by
|
2004-11-03 13:51:07 +00:00
|
|
|
\fIcompar\fP is expected to have two arguments which point to the
|
|
|
|
\fIkey\fP object and to an array member, in that order, and which
|
|
|
|
returns zero if the \fIkey\fP object matches the array member, and
|
intro.1, time.1, adjtimex.2, capget.2, eventfd.2, fcntl.2, getrlimit.2, getsockopt.2, gettimeofday.2, intro.2, ioctl_list.2, ioperm.2, mlock.2, pivot_root.2, poll.2, prctl.2, ptrace.2, sched_setscheduler.2, select_tut.2, semget.2, sigaltstack.2, signalfd.2, sysctl.2, timer_settime.2, timerfd_create.2, wait.2, CPU_SET.3, argz_add.3, assert_perror.3, atexit.3, backtrace.3, bcmp.3, clearenv.3, ctime.3, dl_iterate_phdr.3, dlopen.3, ecvt.3, errno.3, error.3, ether_aton.3, exit.3, fenv.3, ferror.3, finite.3, flockfile.3, fnmatch.3, fpathconf.3, fpclassify.3, ftime.3, ftok.3, ftw.3, fwide.3, getaddrinfo.3, gethostbyname.3, getlogin.3, getnameinfo.3, getnetent.3, getopt.3, getprotoent.3, getrpcent.3, getservent.3, glob.3, hsearch.3, inet.3, isalpha.3, iswalnum.3, iswalpha.3, iswblank.3, iswcntrl.3, iswctype.3, iswdigit.3, iswgraph.3, iswlower.3, iswprint.3, iswpunct.3, iswspace.3, iswupper.3, iswxdigit.3, longjmp.3, lsearch.3, malloc.3, matherr.3, mblen.3, mbsinit.3, mbtowc.3, on_exit.3, printf.3, pthread_attr_init.3, pthread_attr_setaffinity_np.3, pthread_attr_setdetachstate.3, pthread_attr_setguardsize.3, pthread_attr_setinheritsched.3, pthread_attr_setschedparam.3, pthread_attr_setschedpolicy.3, pthread_attr_setscope.3, pthread_attr_setstack.3, pthread_attr_setstackaddr.3, pthread_attr_setstacksize.3, pthread_cancel.3, pthread_cleanup_push.3, pthread_equal.3, pthread_getattr_np.3, pthread_getcpuclockid.3, pthread_setaffinity_np.3, pthread_setcancelstate.3, pthread_setconcurrency.3, pthread_setschedparam.3, pthread_setschedprio.3, ptsname.3, putenv.3, putgrent.3, raise.3, rcmd.3, regex.3, rexec.3, rpc.3, rpmatch.3, rtnetlink.3, scandir.3, sem_init.3, setaliasent.3, setbuf.3, setenv.3, setjmp.3, signbit.3, stdio_ext.3, strtod.3, strtol.3, strtoul.3, system.3, termios.3, timeradd.3, tzset.3, ualarm.3, wctomb.3, xdr.3, st.4, tty_ioctl.4, core.5, elf.5, proc.5, bootparam.7, capabilities.7, icmp.7, ip.7, ipv6.7, math_error.7, mdoc.samples.7, mq_overview.7, pthreads.7, raw.7, regex.7, socket.7, tcp.7, tzselect.8: Global fix: s/non-zero/nonzero/
The tendency in English, as prescribed in style guides like
Chicago MoS, is towards removing hyphens after prefixes
like "non-" etc.
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2010-01-16 16:40:55 +00:00
|
|
|
nonzero otherwise.
|
2004-11-03 13:51:07 +00:00
|
|
|
.PP
|
2007-05-12 09:06:04 +00:00
|
|
|
If
|
|
|
|
.BR lsearch ()
|
|
|
|
does not find a matching element, then the \fIkey\fP
|
2007-11-29 17:59:49 +00:00
|
|
|
object is inserted at the end of the table, and \fI*nmemb\fP is
|
2004-11-03 13:51:07 +00:00
|
|
|
incremented.
|
|
|
|
In particular, one should know that a matching element
|
|
|
|
exists, or that more room is available.
|
|
|
|
.SH "RETURN VALUE"
|
2007-05-12 09:06:04 +00:00
|
|
|
.BR lfind ()
|
|
|
|
returns a pointer to a matching member of the array, or
|
2007-06-21 22:55:04 +00:00
|
|
|
NULL if no match is found.
|
2007-05-12 09:06:04 +00:00
|
|
|
.BR lsearch ()
|
|
|
|
returns a pointer to
|
2004-11-03 13:51:07 +00:00
|
|
|
a matching member of the array, or to the newly added member if no
|
|
|
|
match is found.
|
|
|
|
.SH "CONFORMING TO"
|
2006-08-03 13:57:30 +00:00
|
|
|
SVr4, 4.3BSD, POSIX.1-2001.
|
2004-11-03 13:51:07 +00:00
|
|
|
Present in libc since libc-4.6.27.
|
|
|
|
.SH BUGS
|
|
|
|
The naming is unfortunate.
|
|
|
|
.SH "SEE ALSO"
|
|
|
|
.BR bsearch (3),
|
|
|
|
.BR hsearch (3),
|
|
|
|
.BR tsearch (3)
|