Merge commit 'c5bab7026b8e0ac44b25ee08507ea360f177d844' into merges
[unleashed.git] / share / man / man3head / search.h.3head
blob41a62b6c5a0eed92e1ecf22a8e17281c82361324
1 '\" te
2 .\" Copyright (c) 2001, The IEEE and The Open Group. All Rights Reserved. Portions Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved.
3 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at
4 .\" http://www.opengroup.org/bookstore/.
5 .\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html.
6 .\"  This notice shall appear on any product containing this material.
7 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
8 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
9 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
10 .TH SEARCH.H 3HEAD "Sep 10, 2004"
11 .SH NAME
12 search.h, search \- search tables
13 .SH SYNOPSIS
14 .LP
15 .nf
16 #include <\fBsearch.h\fR>
17 .fi
19 .SH DESCRIPTION
20 .sp
21 .LP
22 The <\fBsearch.h\fR> header defines the \fBENTRY\fR type for structure
23 \fBentry\fR, which includes the following members:
24 .sp
25 .in +2
26 .nf
27 char *key
28 void *data
29 .fi
30 .in -2
32 .sp
33 .LP
34 and defines \fBACTION\fR and \fBVISIT\fR as enumeration data types through type
35 definitions as follows:
36 .sp
37 .in +2
38 .nf
39 enum { FIND, ENTER } ACTION;
40 enum { preorder, postorder, endorder, leaf } VISIT;
41 .fi
42 .in -2
44 .sp
45 .LP
46 The \fBsize_t\fR type is defined as described in <\fBsys/types.h\fR>. See
47 \fBtypes.h\fR(3HEAD).
48 .SH ATTRIBUTES
49 .sp
50 .LP
51 See \fBattributes\fR(5) for descriptions of the following attributes:
52 .sp
54 .sp
55 .TS
56 box;
57 c | c
58 l | l .
59 ATTRIBUTE TYPE  ATTRIBUTE VALUE
61 Interface Stability     Standard
62 .TE
64 .SH SEE ALSO
65 .sp
66 .LP
67 \fBhsearch\fR(3C), \fBinsque\fR(3C), \fBlsearch\fR(3C), \fBtsearch\fR(3C),
68 \fBtypes.h\fR(3HEAD), \fBattributes\fR(5), \fBstandards\fR(5)