\"      $NetBSD: prop_dictionary_util.3,v 1.1 2006/10/26 05:02:12 thorpej Exp $
\"
\" Copyright (c) 2006 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.
\" 3. All advertising materials mentioning features or use of this software
\" must display the following acknowledgement:
\" This product includes software developed by the NetBSD
\" Foundation, Inc. and its contributors.
\" 4. Neither the name of The NetBSD Foundation nor the names of its
\" contributors may be used to endorse or promote products derived
\" from this software without specific prior written permission.
\"
\" 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 October 25, 2006
Dt PROP_DICTIONARY_UTIL 3
Os
Sh NAME
Nm prop_dictionary_util ,
Nm prop_dictionary_get_bool ,
Nm prop_dictionary_set_bool ,
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_cstring ,
Nm prop_dictionary_set_cstring ,
Nm prop_dictionary_get_cstring_nocopy ,
Nm prop_dictionary_set_cstring_nocopy
Sh LIBRARY
Lb libprop
Sh SYNOPSIS
In prop/proplib.h
\"
Ft boolean_t
Fn prop_dictionary_get_bool "prop_dictionary_t dict" "cosnt char *key" \
   "boolean_t *valp"
Ft boolean_t
Fn prop_dictionary_set_bool "prop_dictionary_t dict" "const char *key" \
   "boolean_t val"
\"
Ft boolean_t
Fn prop_dictionary_get_int8 "prop_dictionary_t dict" "const char *key" \
   "int8_t *valp"
Ft boolean_t
Fn prop_dictionary_get_uint8 "prop_dictionary_t dict" "const char *key" \
   "uint8_t *valp"
Ft boolean_t
Fn prop_dictionary_set_int8 "prop_dictionary_t dict" "const char *key" \
   "int8_t val"
Ft boolean_t
Fn prop_dictionary_set_uint8 "prop_dictionary_t dict" "const char *key" \
   "uint8_t val"
\"
Ft boolean_t
Fn prop_dictionary_get_int16 "prop_dictionary_t dict" "const char *key" \
   "int16_t *valp"
Ft boolean_t
Fn prop_dictionary_get_uint16 "prop_dictionary_t dict" "const char *key" \
   "uint16_t *valp"
Ft boolean_t
Fn prop_dictionary_set_int16 "prop_dictionary_t dict" "const char *key" \
   "int16_t val"
Ft boolean_t
Fn prop_dictionary_set_uint16 "prop_dictionary_t dict" "const char *key" \
   "uint16_t val"
\"
Ft boolean_t
Fn prop_dictionary_get_int32 "prop_dictionary_t dict" "const char *key" \
   "int32_t *valp"
Ft boolean_t
Fn prop_dictionary_get_uint32 "prop_dictionary_t dict" "const char *key" \
   "uint32_t *valp"
Ft boolean_t
Fn prop_dictionary_set_int32 "prop_dictionary_t dict" "const char *key" \
   "int32_t val"
Ft boolean_t
Fn prop_dictionary_set_uint32 "prop_dictionary_t dict" "const char *key" \
   "uint32_t val"
\"
Ft boolean_t
Fn prop_dictionary_get_int64 "prop_dictionary_t dict" "const char *key" \
   "int64_t *valp"
Ft boolean_t
Fn prop_dictionary_get_uint64 "prop_dictionary_t dict" "const char *key" \
   "uint64_t *valp"
Ft boolean_t
Fn prop_dictionary_set_int64 "prop_dictionary_t dict" "const char *key" \
   "int64_t val"
Ft boolean_t
Fn prop_dictionary_set_uint64 "prop_dictionary_t dict" "const char *key" \
   "uint64_t val"
\"
Ft boolean_t
Fn prop_dictionary_get_cstring "prop_dictionary_t dict" "const char *key" \
   "char **strp"
Ft boolean_t
Fn prop_dictionary_set_cstring "prop_dictionary_t dict" "const char *key" \
   "const char *str"
\"
Ft boolean_t
Fn prop_dictionary_get_cstring_nocopy "prop_dictionary_t dict" \
   "const char *key" "const char **strp"
Ft boolean_t
Fn prop_dictionary_set_cstring_nocopy "prop_dictionary_t dict" \
   "const char *key" "const char *strp"
Sh DESCRIPTION
The
Nm prop_dictionary_util
family of functions are provided to make getting and setting values in
dictionaries more convenient in some applications.
Pp
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.
Pp
The setters handle object creation and release for the caller.
Pp
The
Fn prop_dictionary_get_cstring
function returns dynamically allocated memory.
See
Xr prop_string 3
for more information.
Pp
The
Fn prop_dictionary_get_cstring_nocopy
and
Fn prop_dictionary_set_cstring_nocopy
functions do not copy the string that is set or returned.
See
Xr prop_string 3
for more information.
Sh RETURN VALUES
The
Nm prop_dictionary_util
getter functions return
Dv TRUE
if the object exists in the dictionary and the value is in-range, or
Dv FALSE
otherwise.
Pp
The
Nm prop_dictionary_util
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_dictionary 3 ,
Xr prop_number 3 ,
Xr proplib 3
Sh HISTORY
The
Nm proplib
property container object library first appeared in
Nx 4.0 .

You are viewing proxied material from ftp.icm.edu.pl. The copyright of proxied material belongs to its original authors. Any comments or complaints in relation to proxied material should be directed to the original authors of the content concerned. Please see the disclaimer for more details.