common/lib/libprop/prop_array_util.3

   1 .\"     $NetBSD: prop_array_util.3,v 1.2 2008/06/04 07:46:48 wiz Exp $
   2 .\"
   3 .\" Copyright (c) 2006 The NetBSD Foundation, Inc.
   4 .\" All rights reserved.
   5 .\"
   6 .\" This code is derived from software contributed to The NetBSD Foundation
   7 .\" by Jason R. Thorpe.
   8 .\"
   9 .\" Redistribution and use in source and binary forms, with or without
  10 .\" modification, are permitted provided that the following conditions
  11 .\" are met:
  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.
  17 .\"
  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.
  29 .\"
  30 .Dd June 2, 2008
  31 .Dt PROP_ARRAY_UTIL 3
  32 .Os
  33 .Sh NAME
  34 .Nm prop_array_util ,
  35 .Nm prop_array_get_bool ,
  36 .Nm prop_array_set_bool ,
  37 .Nm prop_array_get_int8 ,
  38 .Nm prop_array_get_uint8 ,
  39 .Nm prop_array_set_int8 ,
  40 .Nm prop_array_set_uint8 ,
  41 .Nm prop_array_get_int16 ,
  42 .Nm prop_array_get_uint16 ,
  43 .Nm prop_array_set_int16 ,
  44 .Nm prop_array_set_uint16 ,
  45 .Nm prop_array_get_int32 ,
  46 .Nm prop_array_get_uint32 ,
  47 .Nm prop_array_set_int32 ,
  48 .Nm prop_array_set_uint32 ,
  49 .Nm prop_array_get_int64 ,
  50 .Nm prop_array_get_uint64 ,
  51 .Nm prop_array_set_int64 ,
  52 .Nm prop_array_set_uint64 ,
  53 .Nm prop_array_add_int8 ,
  54 .Nm prop_array_add_uint8 ,
  55 .Nm prop_array_add_int16 ,
  56 .Nm prop_array_add_uint16 ,
  57 .Nm prop_array_add_int32 ,
  58 .Nm prop_array_add_uint32 ,
  59 .Nm prop_array_add_int64 ,
  60 .Nm prop_array_add_uint64 ,
  61 .Nm prop_array_get_cstring ,
  62 .Nm prop_array_set_cstring ,
  63 .Nm prop_array_get_cstring_nocopy ,
  64 .Nm prop_array_set_cstring_nocopy
  65 .Sh LIBRARY
  66 .Lb libprop
  67 .Sh SYNOPSIS
  68 .In prop/proplib.h
  69 .\"
  70 .Ft bool
  71 .Fn prop_array_get_bool "prop_array_t dict" "unsigned int indx" \
  72     "bool *valp"
  73 .Ft bool
  74 .Fn prop_array_set_bool "prop_array_t dict" "unsigned int indx" \
  75     "bool val"
  76 .\"
  77 .Ft bool
  78 .Fn prop_array_get_int8 "prop_array_t dict" "unsigned int indx" \
  79     "int8_t *valp"
  80 .Ft bool
  81 .Fn prop_array_get_uint8 "prop_array_t dict" "unsigned int indx" \
  82     "uint8_t *valp"
  83 .Ft bool
  84 .Fn prop_array_set_int8 "prop_array_t dict" "unsigned int indx" \
  85     "int8_t val"
  86 .Ft bool
  87 .Fn prop_array_set_uint8 "prop_array_t dict" "unsigned int indx" \
  88     "uint8_t val"
  89 .\"
  90 .Ft bool
  91 .Fn prop_array_get_int16 "prop_array_t dict" "unsigned int indx" \
  92     "int16_t *valp"
  93 .Ft bool
  94 .Fn prop_array_get_uint16 "prop_array_t dict" "unsigned int indx" \
  95     "uint16_t *valp"
  96 .Ft bool
  97 .Fn prop_array_set_int16 "prop_array_t dict" "unsigned int indx" \
  98     "int16_t val"
  99 .Ft bool
 100 .Fn prop_array_set_uint16 "prop_array_t dict" "unsigned int indx" \
 101     "uint16_t val"
 102 .\"
 103 .Ft bool
 104 .Fn prop_array_get_int32 "prop_array_t dict" "unsigned int indx" \
 105     "int32_t *valp"
 106 .Ft bool
 107 .Fn prop_array_get_uint32 "prop_array_t dict" "unsigned int indx" \
 108     "uint32_t *valp"
 109 .Ft bool
 110 .Fn prop_array_set_int32 "prop_array_t dict" "unsigned int indx" \
 111     "int32_t val"
 112 .Ft bool
 113 .Fn prop_array_set_uint32 "prop_array_t dict" "unsigned int indx" \
 114     "uint32_t val"
 115 .\"
 116 .Ft bool
 117 .Fn prop_array_get_int64 "prop_array_t dict" "unsigned int indx" \
 118     "int64_t *valp"
 119 .Ft bool
 120 .Fn prop_array_get_uint64 "prop_array_t dict" "unsigned int indx" \
 121     "uint64_t *valp"
 122 .Ft bool
 123 .Fn prop_array_set_int64 "prop_array_t dict" "unsigned int indx" \
 124     "int64_t val"
 125 .Ft bool
 126 .Fn prop_array_set_uint64 "prop_array_t dict" "unsigned int indx" \
 127     "uint64_t val"
 128 .\"
 129 .Ft bool
 130 .Fn prop_array_set_int32 "prop_array_t dict" "unsigned int indx" \
 131     "int32_t val"
 132 .Ft bool
 133 .Fn prop_array_set_uint32 "prop_array_t dict" "unsigned int indx" \
 134     "uint32_t val"
 135 .\"
 136 .Ft bool
 137 .Fn prop_array_add_int8 "prop_array_t dict" "int8_t val"
 138 .Ft bool
 139 .Fn prop_array_add_uint8 "prop_array_t dict" "uint8_t val"
 140 .Ft bool
 141 .Fn prop_array_add_int16 "prop_array_t dict"  "int16_t val"
 142 .Ft bool
 143 .Fn prop_array_add_uint16 "prop_array_t dict" "uint16_t val"
 144 .Ft bool
 145 .Fn prop_array_add_int32 "prop_array_t dict" "int32_t val"
 146 .Ft bool
 147 .Fn prop_array_add_uint32 "prop_array_t dict" "uint32_t val"
 148 .Ft bool
 149 .Fn prop_array_add_int64 "prop_array_t dict"  "int64_t val"
 150 .Ft bool
 151 .Fn prop_array_add_uint64 "prop_array_t dict" "uint64_t val"
 152 .\"
 153 .Ft bool
 154 .Fn prop_array_get_cstring "prop_array_t dict" "unsigned int indx" \
 155     "char **strp"
 156 .Ft bool
 157 .Fn prop_array_set_cstring "prop_array_t dict" "unsigned int indx" \
 158     "const char *str"
 159 .\"
 160 .Ft bool
 161 .Fn prop_array_get_cstring_nocopy "prop_array_t dict" \
 162     "unsigned int indx" "const char **strp"
 163 .Ft bool
 164 .Fn prop_array_set_cstring_nocopy "prop_array_t dict" \
 165     "unsigned int indx" "const char *strp"
 166 .Sh DESCRIPTION
 167 The
 168 .Nm prop_array_util
 169 family of functions are provided to make getting and setting values in
 170 arrays more convenient in some applications.
 171 .Pp
 172 The getters check the type of the returned object and, in some cases, also
 173 ensure that the returned value is within the range implied by the getter's
 174 value type.
 175 .Pp
 176 The setters handle object creation and release for the caller.
 177 .Pp
 178 The
 179 .Fn prop_array_get_cstring
 180 function returns dynamically allocated memory.
 181 See
 182 .Xr prop_string 3
 183 for more information.
 184 .Pp
 185 The
 186 .Fn prop_array_get_cstring_nocopy
 187 and
 188 .Fn prop_array_set_cstring_nocopy
 189 functions do not copy the string that is set or returned.
 190 See
 191 .Xr prop_string 3
 192 for more information.
 193 .Sh RETURN VALUES
 194 The
 195 .Nm prop_array_util
 196 getter functions return
 197 .Dv true
 198 if the object exists in the array and the value is in-range, or
 199 .Dv false
 200 otherwise.
 201 .Pp
 202 The
 203 .Nm prop_array_util
 204 setter functions return
 205 .Dv true
 206 if creating the object and storing it in the array is successful, or
 207 .Dv false
 208 otherwise.
 209 .Sh SEE ALSO
 210 .Xr prop_array 3 ,
 211 .Xr prop_bool 3 ,
 212 .Xr prop_number 3 ,
 213 .Xr proplib 3
 214 .Sh HISTORY
 215 The
 216 .Nm proplib
 217 property container object library first appeared in
 218 .Nx 4.0 .