xref: /freebsd/lib/libutil/property.3 (revision 0640d357f29fb1c0daaaffadd0416c5981413afd)
1.\"
2.\" Copyright (c) 1998 Jordan Hubbard
3.\"
4.\" All rights reserved.
5.\"
6.\" Redistribution and use in source and binary forms, with or without
7.\" modification, are permitted provided that the following conditions
8.\" are met:
9.\" 1. Redistributions of source code must retain the above copyright
10.\"    notice, this list of conditions and the following disclaimer.
11.\" 2. Redistributions in binary form must reproduce the above copyright
12.\"    notice, this list of conditions and the following disclaimer in the
13.\"    documentation and/or other materials provided with the distribution.
14.\"
15.\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR
16.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
17.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
18.\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT,
19.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
20.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
21.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
22.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
24.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25.\"
26.\" $Id: property.3,v 1.2 1998/10/09 07:33:58 jkh Exp $
27.\" "
28.Dd October 7, 1998
29.Os
30.Dt properties 3
31.Sh NAME
32.Nm properties_read ,
33.Nm propery_find ,
34.Nm properties_free
35.Nd functions to allow creating simple property lists from ascii file data.
36.Sh SYNOPSIS
37.Fd #include <sys/types.h>
38.Fd #include <libutil.h>
39.Ft properties
40.Fn properties_read "int fd"
41.Ft char *
42.Fn property_find "properties list" "char *name"
43.Ft void
44.Fn properties_free "properties list"
45.Pp
46Link with
47.Va -lutil
48on the
49.Xr cc 1
50command line.
51.Sh DESCRIPTION
52.nf
53typedef struct _properties {
54	struct _properties *next;
55	char *name;
56	char *value;
57} *properties;
58.fi
59
60The function
61.Fn properties_read
62reads
63.Fa name = value
64pairs from the file descriptor passed in
65.Fa fd
66and returns the head of a new property list, assuming that the
67file's contents have been parsed properly, or NULL in case
68of error.  The property list pointer should be passed to
69.Fn properties_free
70when no longer needed.
71.Pp
72.Fn property_find
73Returns the associated value string for the property named
74.Fa name
75if found, otherwise NULL.
76.Pp
77.Fn properties_free
78is used to free the structure returned by
79.Fn properties_read
80when it is no longer needed.
81.Sh SEE ALSO
82.Xr auth_getval 3
83.Sh BUGS
84Simplistic.
85