1 .\" $NetBSD: prop_dictionary_util.3,v 1.4 2008/06/02 09:27:04 haad Exp $
3 .\" Copyright (c) 2006 The NetBSD Foundation, Inc.
4 .\" All rights reserved.
6 .\" This code is derived from software contributed to The NetBSD Foundation
7 .\" by Jason R. Thorpe.
9 .\" Redistribution and use in source and binary forms, with or without
10 .\" modification, are permitted provided that the following conditions
12 .\" 1. Redistributions of source code must retain the above copyright
13 .\" notice, this list of conditions and the following disclaimer.
14 .\" 2. Redistributions in binary form must reproduce the above copyright
15 .\" notice, this list of conditions and the following disclaimer in the
16 .\" documentation and/or other materials provided with the distribution.
18 .\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
19 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
20 .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
21 .\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
22 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28 .\" POSSIBILITY OF SUCH DAMAGE.
31 .Dt PROP_DICTIONARY_UTIL 3
34 .Nm prop_dictionary_util ,
35 .Nm prop_dictionary_get_bool ,
36 .Nm prop_dictionary_set_bool ,
37 .Nm prop_dictionary_get_int8 ,
38 .Nm prop_dictionary_get_uint8 ,
39 .Nm prop_dictionary_set_int8 ,
40 .Nm prop_dictionary_set_uint8 ,
41 .Nm prop_dictionary_get_int16 ,
42 .Nm prop_dictionary_get_uint16 ,
43 .Nm prop_dictionary_set_int16 ,
44 .Nm prop_dictionary_set_uint16 ,
45 .Nm prop_dictionary_get_int32 ,
46 .Nm prop_dictionary_get_uint32 ,
47 .Nm prop_dictionary_set_int32 ,
48 .Nm prop_dictionary_set_uint32 ,
49 .Nm prop_dictionary_get_int64 ,
50 .Nm prop_dictionary_get_uint64 ,
51 .Nm prop_dictionary_set_int64 ,
52 .Nm prop_dictionary_set_uint64 ,
53 .Nm prop_dictionary_get_cstring ,
54 .Nm prop_dictionary_set_cstring ,
55 .Nm prop_dictionary_get_cstring_nocopy ,
56 .Nm prop_dictionary_set_cstring_nocopy
57 .Nd dictionary property collection object utility functions
64 .Fn prop_dictionary_get_bool "prop_dictionary_t dict" "const char *key" \
67 .Fn prop_dictionary_set_bool "prop_dictionary_t dict" "const char *key" \
71 .Fn prop_dictionary_get_int8 "prop_dictionary_t dict" "const char *key" \
74 .Fn prop_dictionary_get_uint8 "prop_dictionary_t dict" "const char *key" \
77 .Fn prop_dictionary_set_int8 "prop_dictionary_t dict" "const char *key" \
80 .Fn prop_dictionary_set_uint8 "prop_dictionary_t dict" "const char *key" \
84 .Fn prop_dictionary_get_int16 "prop_dictionary_t dict" "const char *key" \
87 .Fn prop_dictionary_get_uint16 "prop_dictionary_t dict" "const char *key" \
90 .Fn prop_dictionary_set_int16 "prop_dictionary_t dict" "const char *key" \
93 .Fn prop_dictionary_set_uint16 "prop_dictionary_t dict" "const char *key" \
97 .Fn prop_dictionary_get_int32 "prop_dictionary_t dict" "const char *key" \
100 .Fn prop_dictionary_get_uint32 "prop_dictionary_t dict" "const char *key" \
103 .Fn prop_dictionary_set_int32 "prop_dictionary_t dict" "const char *key" \
106 .Fn prop_dictionary_set_uint32 "prop_dictionary_t dict" "const char *key" \
110 .Fn prop_dictionary_get_int64 "prop_dictionary_t dict" "const char *key" \
113 .Fn prop_dictionary_get_uint64 "prop_dictionary_t dict" "const char *key" \
116 .Fn prop_dictionary_set_int64 "prop_dictionary_t dict" "const char *key" \
119 .Fn prop_dictionary_set_uint64 "prop_dictionary_t dict" "const char *key" \
123 .Fn prop_dictionary_get_cstring "prop_dictionary_t dict" "const char *key" \
126 .Fn prop_dictionary_set_cstring "prop_dictionary_t dict" "const char *key" \
130 .Fn prop_dictionary_get_cstring_nocopy "prop_dictionary_t dict" \
131 "const char *key" "const char **strp"
133 .Fn prop_dictionary_set_cstring_nocopy "prop_dictionary_t dict" \
134 "const char *key" "const char *strp"
137 .Nm prop_dictionary_util
138 family of functions are provided to make getting and setting values in
139 dictionaries more convenient in some applications.
141 The getters check the type of the returned object and, in some cases, also
142 ensure that the returned value is within the range implied by the getter's
145 The setters handle object creation and release for the caller.
148 .Fn prop_dictionary_get_cstring
149 function returns dynamically allocated memory.
152 for more information.
155 .Fn prop_dictionary_get_cstring_nocopy
157 .Fn prop_dictionary_set_cstring_nocopy
158 functions do not copy the string that is set or returned.
161 for more information.
164 .Nm prop_dictionary_util
165 getter functions return
167 if the object exists in the dictionary and the value is in-range, or
172 .Nm prop_dictionary_util
173 setter functions return
175 if creating the object and storing it in the dictionary is successful, or
180 .Xr prop_dictionary 3 ,
186 property container object library first appeared in