1.\" $NetBSD: prop_array_util.3,v 1.10 2017/02/12 16:00:53 abhinav 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 May 31, 2016 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_add_cstring , 62.Nm prop_array_get_cstring , 63.Nm prop_array_set_cstring , 64.Nm prop_array_add_cstring_nocopy , 65.Nm prop_array_get_cstring_nocopy , 66.Nm prop_array_set_cstring_nocopy , 67.Nm prop_array_add_and_rel 68.Nd array property collection object utility functions 69.Sh LIBRARY 70.Lb libprop 71.Sh SYNOPSIS 72.In prop/proplib.h 73.\" 74.Ft bool 75.Fn prop_array_get_bool "prop_array_t dict" "unsigned int indx" \ 76 "bool *valp" 77.Ft bool 78.Fn prop_array_set_bool "prop_array_t dict" "unsigned int indx" \ 79 "bool val" 80.\" 81.Ft bool 82.Fn prop_array_get_int8 "prop_array_t dict" "unsigned int indx" \ 83 "int8_t *valp" 84.Ft bool 85.Fn prop_array_get_uint8 "prop_array_t dict" "unsigned int indx" \ 86 "uint8_t *valp" 87.Ft bool 88.Fn prop_array_set_int8 "prop_array_t dict" "unsigned int indx" \ 89 "int8_t val" 90.Ft bool 91.Fn prop_array_set_uint8 "prop_array_t dict" "unsigned int indx" \ 92 "uint8_t val" 93.\" 94.Ft bool 95.Fn prop_array_get_int16 "prop_array_t dict" "unsigned int indx" \ 96 "int16_t *valp" 97.Ft bool 98.Fn prop_array_get_uint16 "prop_array_t dict" "unsigned int indx" \ 99 "uint16_t *valp" 100.Ft bool 101.Fn prop_array_set_int16 "prop_array_t dict" "unsigned int indx" \ 102 "int16_t val" 103.Ft bool 104.Fn prop_array_set_uint16 "prop_array_t dict" "unsigned int indx" \ 105 "uint16_t val" 106.\" 107.Ft bool 108.Fn prop_array_get_int32 "prop_array_t dict" "unsigned int indx" \ 109 "int32_t *valp" 110.Ft bool 111.Fn prop_array_get_uint32 "prop_array_t dict" "unsigned int indx" \ 112 "uint32_t *valp" 113.Ft bool 114.Fn prop_array_set_int32 "prop_array_t dict" "unsigned int indx" \ 115 "int32_t val" 116.Ft bool 117.Fn prop_array_set_uint32 "prop_array_t dict" "unsigned int indx" \ 118 "uint32_t val" 119.\" 120.Ft bool 121.Fn prop_array_get_int64 "prop_array_t dict" "unsigned int indx" \ 122 "int64_t *valp" 123.Ft bool 124.Fn prop_array_get_uint64 "prop_array_t dict" "unsigned int indx" \ 125 "uint64_t *valp" 126.Ft bool 127.Fn prop_array_set_int64 "prop_array_t dict" "unsigned int indx" \ 128 "int64_t val" 129.Ft bool 130.Fn prop_array_set_uint64 "prop_array_t dict" "unsigned int indx" \ 131 "uint64_t val" 132.\" 133.Ft bool 134.Fn prop_array_set_int32 "prop_array_t dict" "unsigned int indx" \ 135 "int32_t val" 136.Ft bool 137.Fn prop_array_set_uint32 "prop_array_t dict" "unsigned int indx" \ 138 "uint32_t val" 139.\" 140.Ft bool 141.Fn prop_array_add_int8 "prop_array_t dict" "int8_t val" 142.Ft bool 143.Fn prop_array_add_uint8 "prop_array_t dict" "uint8_t val" 144.Ft bool 145.Fn prop_array_add_int16 "prop_array_t dict" "int16_t val" 146.Ft bool 147.Fn prop_array_add_uint16 "prop_array_t dict" "uint16_t val" 148.Ft bool 149.Fn prop_array_add_int32 "prop_array_t dict" "int32_t val" 150.Ft bool 151.Fn prop_array_add_uint32 "prop_array_t dict" "uint32_t val" 152.Ft bool 153.Fn prop_array_add_int64 "prop_array_t dict" "int64_t val" 154.Ft bool 155.Fn prop_array_add_uint64 "prop_array_t dict" "uint64_t val" 156.\" 157.Ft bool 158.Fn prop_array_add_cstring "prop_array_t dict" "const char *cp" 159.Ft bool 160.Fn prop_array_get_cstring "prop_array_t dict" "unsigned int indx" \ 161 "char **strp" 162.Ft bool 163.Fn prop_array_set_cstring "prop_array_t dict" "unsigned int indx" \ 164 "const char *str" 165.\" 166.Ft bool 167.Fn prop_array_add_cstring_nocopy "prop_array_t dict" "const char *cp" 168.Ft bool 169.Fn prop_array_get_cstring_nocopy "prop_array_t dict" \ 170 "unsigned int indx" "const char **strp" 171.Ft bool 172.Fn prop_array_set_cstring_nocopy "prop_array_t dict" \ 173 "unsigned int indx" "const char *strp" 174.Ft bool 175.Fn prop_array_add_and_rel "prop_array_t dict" \ 176 "prop_object_t obj" 177.Sh DESCRIPTION 178The 179.Fn prop_array_util 180family of functions are provided to make getting and setting values in 181arrays more convenient in some applications. 182.Pp 183The getters check the type of the returned object and, in some cases, also 184ensure that the returned value is within the range implied by the getter's 185value type. 186.Pp 187The setters handle object creation and release for the caller. 188.Pp 189The 190.Fn prop_array_add_cstring 191and 192.Fn prop_array_get_cstring 193functions returns dynamically allocated memory. 194See 195.Xr prop_string 3 196for more information. 197.Pp 198The 199.Fn prop_array_add_cstring_nocopy , 200.Fn prop_array_get_cstring_nocopy , 201and 202.Fn prop_array_set_cstring_nocopy 203functions do not copy the string that is set or returned. 204See 205.Xr prop_string 3 206for more information. 207.Pp 208The 209.Fn prop_array_add_and_rel 210function adds the object to the end of the array and releases it. 211The object is also released on failure. 212.Sh RETURN VALUES 213The 214.Fn prop_array_util 215getter functions return 216.Dv true 217if the object exists in the array and the value is in-range, or 218.Dv false 219otherwise. 220.Pp 221The 222.Fn prop_array_util 223setter functions return 224.Dv true 225if creating the object and storing it in the array is successful, or 226.Dv false 227otherwise. 228.Sh SEE ALSO 229.Xr prop_array 3 , 230.Xr prop_bool 3 , 231.Xr prop_number 3 , 232.Xr proplib 3 233.Sh HISTORY 234The 235.Xr proplib 3 236property container object library first appeared in 237.Nx 4.0 . 238