]>
Commit | Line | Data |
---|---|---|
fea681da MK |
1 | .\" Copyright 1995 Jim Van Zandt <jrv@vanzandt.mv.com> |
2 | .\" | |
93015253 | 3 | .\" %%%LICENSE_START(VERBATIM) |
fea681da MK |
4 | .\" Permission is granted to make and distribute verbatim copies of this |
5 | .\" manual provided the copyright notice and this permission notice are | |
6 | .\" preserved on all copies. | |
7 | .\" | |
8 | .\" Permission is granted to copy and distribute modified versions of this | |
9 | .\" manual under the conditions for verbatim copying, provided that the | |
10 | .\" entire resulting derived work is distributed under the terms of a | |
11 | .\" permission notice identical to this one. | |
c13182ef | 12 | .\" |
fea681da MK |
13 | .\" Since the Linux kernel and libraries are constantly changing, this |
14 | .\" manual page may be incorrect or out-of-date. The author(s) assume no | |
15 | .\" responsibility for errors or omissions, or for damages resulting from | |
16 | .\" the use of the information contained herein. The author(s) may not | |
17 | .\" have taken the same level of care in the production of this manual, | |
18 | .\" which is licensed free of charge, as they might when working | |
19 | .\" professionally. | |
c13182ef | 20 | .\" |
fea681da MK |
21 | .\" Formatted or processed versions of this manual, if unaccompanied by |
22 | .\" the source, must acknowledge the copyright and authors of this work. | |
4b72fb64 | 23 | .\" %%%LICENSE_END |
fea681da MK |
24 | .\" |
25 | .\" Corrected prototype and include, aeb, 990927 | |
26 | .TH LSEARCH 3 1999-09-27 "GNU" "Linux Programmer's Manual" | |
27 | .SH NAME | |
28 | lfind, lsearch \- linear search of an array | |
29 | .SH SYNOPSIS | |
30 | .nf | |
31 | .B #include <search.h> | |
32 | .sp | |
33 | .BI "void *lfind(const void *" key ", const void *" base ", size_t *" nmemb , | |
62218dc0 | 34 | .BI " size_t " size ", int(*" compar ")(const void *, const void *));" |
fea681da MK |
35 | .sp |
36 | .BI "void *lsearch(const void *" key ", void *" base ", size_t *" nmemb , | |
62218dc0 | 37 | .BI " size_t " size ", int(*" compar ")(const void *, const void *));" |
fea681da MK |
38 | .fi |
39 | .SH DESCRIPTION | |
60a90ecd MK |
40 | .BR lfind () |
41 | and | |
42 | .BR lsearch () | |
43 | perform a linear search for | |
35cfd378 MK |
44 | .I key |
45 | in the array | |
51700fd7 | 46 | .IR base |
35cfd378 MK |
47 | which has |
48 | .I *nmemb | |
49 | elements of | |
50 | .I size | |
51 | bytes each. | |
c13182ef | 52 | The comparison function referenced by |
35cfd378 MK |
53 | .I compar |
54 | is expected to have two arguments which point to the | |
55 | .I key | |
56 | object and to an array member, in that order, and which | |
57 | returns zero if the | |
58 | .I key | |
59 | object matches the array member, and | |
c7094399 | 60 | nonzero otherwise. |
fea681da | 61 | .PP |
60a90ecd MK |
62 | If |
63 | .BR lsearch () | |
35cfd378 MK |
64 | does not find a matching element, then the |
65 | .I key | |
66 | object is inserted at the end of the table, and | |
67 | .I *nmemb | |
68 | is | |
fea681da MK |
69 | incremented. |
70 | In particular, one should know that a matching element | |
71 | exists, or that more room is available. | |
47297adb | 72 | .SH RETURN VALUE |
60a90ecd MK |
73 | .BR lfind () |
74 | returns a pointer to a matching member of the array, or | |
988db661 | 75 | NULL if no match is found. |
60a90ecd MK |
76 | .BR lsearch () |
77 | returns a pointer to | |
fea681da MK |
78 | a matching member of the array, or to the newly added member if no |
79 | match is found. | |
47297adb | 80 | .SH CONFORMING TO |
68e1685c | 81 | SVr4, 4.3BSD, POSIX.1-2001. |
fea681da MK |
82 | Present in libc since libc-4.6.27. |
83 | .SH BUGS | |
84 | The naming is unfortunate. | |
47297adb | 85 | .SH SEE ALSO |
fea681da MK |
86 | .BR bsearch (3), |
87 | .BR hsearch (3), | |
88 | .BR tsearch (3) |