$NetBSD: prop_dictionary_util.3,v 1.10 2020/06/06 21:25:59 thorpej Exp $
Copyright (c) 2006, 2020 The NetBSD Foundation, Inc.
All rights reserved.
This code is derived from software contributed to The NetBSD Foundation
by Jason R. Thorpe.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:
1. Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
POSSIBILITY OF SUCH DAMAGE.
.Dd June 2, 2020 .Dt PROP_DICTIONARY_UTIL 3 .Os .Sh NAME .Nm prop_dictionary_util , .Nm prop_dictionary_get_dict , .Nm prop_dictionary_get_bool , .Nm prop_dictionary_set_bool , .Nm prop_dictionary_get_schar , .Nm prop_dictionary_get_uchar , .Nm prop_dictionary_set_schar , .Nm prop_dictionary_set_uchar , .Nm prop_dictionary_get_short , .Nm prop_dictionary_get_ushort , .Nm prop_dictionary_set_short , .Nm prop_dictionary_set_ushort , .Nm prop_dictionary_get_int , .Nm prop_dictionary_get_uint , .Nm prop_dictionary_set_int , .Nm prop_dictionary_set_uint , .Nm prop_dictionary_get_long , .Nm prop_dictionary_get_ulong , .Nm prop_dictionary_set_long , .Nm prop_dictionary_set_ulong , .Nm prop_dictionary_get_longlong , .Nm prop_dictionary_get_ulonglong , .Nm prop_dictionary_set_longlong , .Nm prop_dictionary_set_ulonglong , .Nm prop_dictionary_get_intptr , .Nm prop_dictionary_get_uintptr , .Nm prop_dictionary_set_intptr , .Nm prop_dictionary_set_uintptr , .Nm prop_dictionary_get_int8 , .Nm prop_dictionary_get_uint8 , .Nm prop_dictionary_set_int8 , .Nm prop_dictionary_set_uint8 , .Nm prop_dictionary_get_int16 , .Nm prop_dictionary_get_uint16 , .Nm prop_dictionary_set_int16 , .Nm prop_dictionary_set_uint16 , .Nm prop_dictionary_get_int32 , .Nm prop_dictionary_get_uint32 , .Nm prop_dictionary_set_int32 , .Nm prop_dictionary_set_uint32 , .Nm prop_dictionary_get_int64 , .Nm prop_dictionary_get_uint64 , .Nm prop_dictionary_set_int64 , .Nm prop_dictionary_set_uint64 , .Nm prop_dictionary_get_data , .Nm prop_dictionary_set_data , .Nm prop_dictionary_set_data_nocopy , .Nm prop_dictionary_get_string , .Nm prop_dictionary_set_string , .Nm prop_dictionary_set_string_nocopy , .Nm prop_dictionary_set_and_rel .Nd dictionary property collection object utility functions .Sh LIBRARY .Lb libprop .Sh SYNOPSIS n prop/proplib.h
.Ft bool .Fn prop_dictionary_get_dict "prop_dictionary_t dict" "const char *key" \ "prop_dictionary_t *dictp" .Ft bool .Fn prop_dictionary_get_bool "prop_dictionary_t dict" "const char *key" \ "bool *valp" .Ft bool .Fn prop_dictionary_set_bool "prop_dictionary_t dict" "const char *key" \ "bool val"
.Ft bool .Fn prop_dictionary_get_schar "prop_dictionary_t dict" "const char *key" \ "signed char *valp" .Ft bool .Fn prop_dictionary_get_uchar "prop_dictionary_t dict" "const char *key" \ "unsigned char *valp" .Ft bool .Fn prop_dictionary_set_schar "prop_dictionary_t dict" "const char *key" \ "signed char val" .Ft bool .Fn prop_dictionary_set_uchar "prop_dictionary_t dict" "const char *key" \ "unsigned char val"
.Ft bool .Fn prop_dictionary_get_short "prop_dictionary_t dict" "const char *key" \ "short *valp" .Ft bool .Fn prop_dictionary_get_ushort "prop_dictionary_t dict" "const char *key" \ "unsigned short *valp" .Ft bool .Fn prop_dictionary_set_short "prop_dictionary_t dict" "const char *key" \ "short val" .Ft bool .Fn prop_dictionary_set_ushort "prop_dictionary_t dict" "const char *key" \ "unsigned short val"
.Ft bool .Fn prop_dictionary_get_int "prop_dictionary_t dict" "const char *key" \ "int *valp" .Ft bool .Fn prop_dictionary_get_uint "prop_dictionary_t dict" "const char *key" \ "unsigned int *valp" .Ft bool .Fn prop_dictionary_set_int "prop_dictionary_t dict" "const char *key" \ "int val" .Ft bool .Fn prop_dictionary_set_uint "prop_dictionary_t dict" "const char *key" \ "unsigned int val"
.Ft bool .Fn prop_dictionary_get_long "prop_dictionary_t dict" "const char *key" \ "long *valp" .Ft bool .Fn prop_dictionary_get_ulong "prop_dictionary_t dict" "const char *key" \ "unsigned long *valp" .Ft bool .Fn prop_dictionary_set_long "prop_dictionary_t dict" "const char *key" \ "long val" .Ft bool .Fn prop_dictionary_set_ulong "prop_dictionary_t dict" "const char *key" \ "unsigned long val"
.Ft bool .Fn prop_dictionary_get_longlong "prop_dictionary_t dict" "const char *key" \ "long long *valp" .Ft bool .Fn prop_dictionary_get_ulonglong "prop_dictionary_t dict" "const char *key" \ "unsigned long long *valp" .Ft bool .Fn prop_dictionary_set_longlong "prop_dictionary_t dict" "const char *key" \ "long long val" .Ft bool .Fn prop_dictionary_set_ulonglong "prop_dictionary_t dict" "const char *key" \ "unsigned long long val"
.Ft bool .Fn prop_dictionary_get_intptr "prop_dictionary_t dict" "const char *key" \ "intptr_t *valp" .Ft bool .Fn prop_dictionary_get_uintptr "prop_dictionary_t dict" "const char *key" \ "uintptr_t *valp" .Ft bool .Fn prop_dictionary_set_intptr "prop_dictionary_t dict" "const char *key" \ "intptr_t val" .Ft bool .Fn prop_dictionary_set_uintptr "prop_dictionary_t dict" "const char *key" \ "uintptr_t val"
.Ft bool .Fn prop_dictionary_get_int8 "prop_dictionary_t dict" "const char *key" \ "int8_t *valp" .Ft bool .Fn prop_dictionary_get_uint8 "prop_dictionary_t dict" "const char *key" \ "uint8_t *valp" .Ft bool .Fn prop_dictionary_set_int8 "prop_dictionary_t dict" "const char *key" \ "int8_t val" .Ft bool .Fn prop_dictionary_set_uint8 "prop_dictionary_t dict" "const char *key" \ "uint8_t val"
.Ft bool .Fn prop_dictionary_get_int16 "prop_dictionary_t dict" "const char *key" \ "int16_t *valp" .Ft bool .Fn prop_dictionary_get_uint16 "prop_dictionary_t dict" "const char *key" \ "uint16_t *valp" .Ft bool .Fn prop_dictionary_set_int16 "prop_dictionary_t dict" "const char *key" \ "int16_t val" .Ft bool .Fn prop_dictionary_set_uint16 "prop_dictionary_t dict" "const char *key" \ "uint16_t val"
.Ft bool .Fn prop_dictionary_get_int32 "prop_dictionary_t dict" "const char *key" \ "int32_t *valp" .Ft bool .Fn prop_dictionary_get_uint32 "prop_dictionary_t dict" "const char *key" \ "uint32_t *valp" .Ft bool .Fn prop_dictionary_set_int32 "prop_dictionary_t dict" "const char *key" \ "int32_t val" .Ft bool .Fn prop_dictionary_set_uint32 "prop_dictionary_t dict" "const char *key" \ "uint32_t val"
.Ft bool .Fn prop_dictionary_get_int64 "prop_dictionary_t dict" "const char *key" \ "int64_t *valp" .Ft bool .Fn prop_dictionary_get_uint64 "prop_dictionary_t dict" "const char *key" \ "uint64_t *valp" .Ft bool .Fn prop_dictionary_set_int64 "prop_dictionary_t dict" "const char *key" \ "int64_t val" .Ft bool .Fn prop_dictionary_set_uint64 "prop_dictionary_t dict" "const char *key" \ "uint64_t val"
.Ft bool .Fn prop_dictionary_get_cstring "prop_dictionary_t dict" "const char *key" \ "char **strp" .Ft bool .Fn prop_dictionary_set_cstring "prop_dictionary_t dict" "const char *key" \ "const char *str"
.Ft bool .Fn prop_dictionary_get_data "prop_dictionary_t dict" \ "const char *key" "const void **datap" "size_t *sizep" .Ft bool .Fn prop_dictionary_set_data "prop_dictionary_t dict" \ "const char *key" "const void *data" "size_t len" .Ft bool .Fn prop_dictionary_set_data_nocopy "prop_dictionary_t dict" \ "const char *key" "const void *data" "size_t len"
.Ft bool .Fn prop_dictionary_get_string "prop_dictionary_t dict" \ "const char *key" "const char **strp" .Ft bool .Fn prop_dictionary_set_string "prop_dictionary_t dict" \ "const char *key" "const char *strp" .Ft bool .Fn prop_dictionary_set_string_nocopy "prop_dictionary_t dict" \ "const char *key" "const char *strp"
.Ft bool .Fn prop_dictionary_set_and_rel "prop_dictionary_t dict" \ "const char *key" "prop_object_t obj" .Sh DESCRIPTION The .Nm family of functions are provided to make getting and setting values in dictionaries more convenient in some applications.
Copyright (c) 2006, 2020 The NetBSD Foundation, Inc.
All rights reserved.
This code is derived from software contributed to The NetBSD Foundation
by Jason R. Thorpe.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:
1. Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
POSSIBILITY OF SUCH DAMAGE.
.Dd June 2, 2020 .Dt PROP_DICTIONARY_UTIL 3 .Os .Sh NAME .Nm prop_dictionary_util , .Nm prop_dictionary_get_dict , .Nm prop_dictionary_get_bool , .Nm prop_dictionary_set_bool , .Nm prop_dictionary_get_schar , .Nm prop_dictionary_get_uchar , .Nm prop_dictionary_set_schar , .Nm prop_dictionary_set_uchar , .Nm prop_dictionary_get_short , .Nm prop_dictionary_get_ushort , .Nm prop_dictionary_set_short , .Nm prop_dictionary_set_ushort , .Nm prop_dictionary_get_int , .Nm prop_dictionary_get_uint , .Nm prop_dictionary_set_int , .Nm prop_dictionary_set_uint , .Nm prop_dictionary_get_long , .Nm prop_dictionary_get_ulong , .Nm prop_dictionary_set_long , .Nm prop_dictionary_set_ulong , .Nm prop_dictionary_get_longlong , .Nm prop_dictionary_get_ulonglong , .Nm prop_dictionary_set_longlong , .Nm prop_dictionary_set_ulonglong , .Nm prop_dictionary_get_intptr , .Nm prop_dictionary_get_uintptr , .Nm prop_dictionary_set_intptr , .Nm prop_dictionary_set_uintptr , .Nm prop_dictionary_get_int8 , .Nm prop_dictionary_get_uint8 , .Nm prop_dictionary_set_int8 , .Nm prop_dictionary_set_uint8 , .Nm prop_dictionary_get_int16 , .Nm prop_dictionary_get_uint16 , .Nm prop_dictionary_set_int16 , .Nm prop_dictionary_set_uint16 , .Nm prop_dictionary_get_int32 , .Nm prop_dictionary_get_uint32 , .Nm prop_dictionary_set_int32 , .Nm prop_dictionary_set_uint32 , .Nm prop_dictionary_get_int64 , .Nm prop_dictionary_get_uint64 , .Nm prop_dictionary_set_int64 , .Nm prop_dictionary_set_uint64 , .Nm prop_dictionary_get_data , .Nm prop_dictionary_set_data , .Nm prop_dictionary_set_data_nocopy , .Nm prop_dictionary_get_string , .Nm prop_dictionary_set_string , .Nm prop_dictionary_set_string_nocopy , .Nm prop_dictionary_set_and_rel .Nd dictionary property collection object utility functions .Sh LIBRARY .Lb libprop .Sh SYNOPSIS n prop/proplib.h
.Ft bool .Fn prop_dictionary_get_dict "prop_dictionary_t dict" "const char *key" \ "prop_dictionary_t *dictp" .Ft bool .Fn prop_dictionary_get_bool "prop_dictionary_t dict" "const char *key" \ "bool *valp" .Ft bool .Fn prop_dictionary_set_bool "prop_dictionary_t dict" "const char *key" \ "bool val"
.Ft bool .Fn prop_dictionary_get_schar "prop_dictionary_t dict" "const char *key" \ "signed char *valp" .Ft bool .Fn prop_dictionary_get_uchar "prop_dictionary_t dict" "const char *key" \ "unsigned char *valp" .Ft bool .Fn prop_dictionary_set_schar "prop_dictionary_t dict" "const char *key" \ "signed char val" .Ft bool .Fn prop_dictionary_set_uchar "prop_dictionary_t dict" "const char *key" \ "unsigned char val"
.Ft bool .Fn prop_dictionary_get_short "prop_dictionary_t dict" "const char *key" \ "short *valp" .Ft bool .Fn prop_dictionary_get_ushort "prop_dictionary_t dict" "const char *key" \ "unsigned short *valp" .Ft bool .Fn prop_dictionary_set_short "prop_dictionary_t dict" "const char *key" \ "short val" .Ft bool .Fn prop_dictionary_set_ushort "prop_dictionary_t dict" "const char *key" \ "unsigned short val"
.Ft bool .Fn prop_dictionary_get_int "prop_dictionary_t dict" "const char *key" \ "int *valp" .Ft bool .Fn prop_dictionary_get_uint "prop_dictionary_t dict" "const char *key" \ "unsigned int *valp" .Ft bool .Fn prop_dictionary_set_int "prop_dictionary_t dict" "const char *key" \ "int val" .Ft bool .Fn prop_dictionary_set_uint "prop_dictionary_t dict" "const char *key" \ "unsigned int val"
.Ft bool .Fn prop_dictionary_get_long "prop_dictionary_t dict" "const char *key" \ "long *valp" .Ft bool .Fn prop_dictionary_get_ulong "prop_dictionary_t dict" "const char *key" \ "unsigned long *valp" .Ft bool .Fn prop_dictionary_set_long "prop_dictionary_t dict" "const char *key" \ "long val" .Ft bool .Fn prop_dictionary_set_ulong "prop_dictionary_t dict" "const char *key" \ "unsigned long val"
.Ft bool .Fn prop_dictionary_get_longlong "prop_dictionary_t dict" "const char *key" \ "long long *valp" .Ft bool .Fn prop_dictionary_get_ulonglong "prop_dictionary_t dict" "const char *key" \ "unsigned long long *valp" .Ft bool .Fn prop_dictionary_set_longlong "prop_dictionary_t dict" "const char *key" \ "long long val" .Ft bool .Fn prop_dictionary_set_ulonglong "prop_dictionary_t dict" "const char *key" \ "unsigned long long val"
.Ft bool .Fn prop_dictionary_get_intptr "prop_dictionary_t dict" "const char *key" \ "intptr_t *valp" .Ft bool .Fn prop_dictionary_get_uintptr "prop_dictionary_t dict" "const char *key" \ "uintptr_t *valp" .Ft bool .Fn prop_dictionary_set_intptr "prop_dictionary_t dict" "const char *key" \ "intptr_t val" .Ft bool .Fn prop_dictionary_set_uintptr "prop_dictionary_t dict" "const char *key" \ "uintptr_t val"
.Ft bool .Fn prop_dictionary_get_int8 "prop_dictionary_t dict" "const char *key" \ "int8_t *valp" .Ft bool .Fn prop_dictionary_get_uint8 "prop_dictionary_t dict" "const char *key" \ "uint8_t *valp" .Ft bool .Fn prop_dictionary_set_int8 "prop_dictionary_t dict" "const char *key" \ "int8_t val" .Ft bool .Fn prop_dictionary_set_uint8 "prop_dictionary_t dict" "const char *key" \ "uint8_t val"
.Ft bool .Fn prop_dictionary_get_int16 "prop_dictionary_t dict" "const char *key" \ "int16_t *valp" .Ft bool .Fn prop_dictionary_get_uint16 "prop_dictionary_t dict" "const char *key" \ "uint16_t *valp" .Ft bool .Fn prop_dictionary_set_int16 "prop_dictionary_t dict" "const char *key" \ "int16_t val" .Ft bool .Fn prop_dictionary_set_uint16 "prop_dictionary_t dict" "const char *key" \ "uint16_t val"
.Ft bool .Fn prop_dictionary_get_int32 "prop_dictionary_t dict" "const char *key" \ "int32_t *valp" .Ft bool .Fn prop_dictionary_get_uint32 "prop_dictionary_t dict" "const char *key" \ "uint32_t *valp" .Ft bool .Fn prop_dictionary_set_int32 "prop_dictionary_t dict" "const char *key" \ "int32_t val" .Ft bool .Fn prop_dictionary_set_uint32 "prop_dictionary_t dict" "const char *key" \ "uint32_t val"
.Ft bool .Fn prop_dictionary_get_int64 "prop_dictionary_t dict" "const char *key" \ "int64_t *valp" .Ft bool .Fn prop_dictionary_get_uint64 "prop_dictionary_t dict" "const char *key" \ "uint64_t *valp" .Ft bool .Fn prop_dictionary_set_int64 "prop_dictionary_t dict" "const char *key" \ "int64_t val" .Ft bool .Fn prop_dictionary_set_uint64 "prop_dictionary_t dict" "const char *key" \ "uint64_t val"
.Ft bool .Fn prop_dictionary_get_cstring "prop_dictionary_t dict" "const char *key" \ "char **strp" .Ft bool .Fn prop_dictionary_set_cstring "prop_dictionary_t dict" "const char *key" \ "const char *str"
.Ft bool .Fn prop_dictionary_get_data "prop_dictionary_t dict" \ "const char *key" "const void **datap" "size_t *sizep" .Ft bool .Fn prop_dictionary_set_data "prop_dictionary_t dict" \ "const char *key" "const void *data" "size_t len" .Ft bool .Fn prop_dictionary_set_data_nocopy "prop_dictionary_t dict" \ "const char *key" "const void *data" "size_t len"
.Ft bool .Fn prop_dictionary_get_string "prop_dictionary_t dict" \ "const char *key" "const char **strp" .Ft bool .Fn prop_dictionary_set_string "prop_dictionary_t dict" \ "const char *key" "const char *strp" .Ft bool .Fn prop_dictionary_set_string_nocopy "prop_dictionary_t dict" \ "const char *key" "const char *strp"
.Ft bool .Fn prop_dictionary_set_and_rel "prop_dictionary_t dict" \ "const char *key" "prop_object_t obj" .Sh DESCRIPTION The .Nm family of functions are provided to make getting and setting values in dictionaries more convenient in some applications.
p The getters check the type of the returned object and, in some cases, also ensure that the returned value is within the range implied by the getter's value type.
p The setters handle object creation and release for the caller.
p If the .Fa sizep argument to .Fn prop_dictionary_get_data is not .Dv NULL , then it will be set to the size of the returned data.
p The .Fn prop_dictionary_get_data and .Fn prop_dictionary_set_data_nocopy functions do not copy the data that is set or returned. See .Xr prop_data 3 for more information.
p The .Fn prop_dictionary_get_string and .Fn prop_dictionary_set_string_nocopy functions do not copy the string that is set or returned. See .Xr prop_string 3 for more information.
p The .Fn prop_dictionary_set_and_rel function adds the object to the dictionary and releases it. The object is always released, even if adding it to the dictionary fails. .Sh RETURN VALUES The .Nm getter functions return .Dv true if the object exists in the dictionary and the value is in-range, or .Dv false otherwise.
p The .Nm setter functions return .Dv true if creating the object and storing it in the dictionary is successful, or .Dv false otherwise. .Sh SEE ALSO .Xr prop_bool 3 , .Xr prop_data 3 , .Xr prop_dictionary 3 , .Xr prop_number 3 , .Xr prop_string 3 , .Xr proplib 3 .Sh HISTORY The .Xr proplib 3 property container object library first appeared in .Nx 4.0 .
Indexes created Sat Sep 20 22:09:52 GMT 2025