NAME
prop_array_util,
prop_array_get_bool,
prop_array_set_bool,
prop_array_get_int8,
prop_array_get_uint8,
prop_array_set_int8,
prop_array_set_uint8,
prop_array_get_int16,
prop_array_get_uint16,
prop_array_set_int16,
prop_array_set_uint16,
prop_array_get_int32,
prop_array_get_uint32,
prop_array_set_int32,
prop_array_set_uint32,
prop_array_get_int64,
prop_array_get_uint64,
prop_array_set_int64,
prop_array_set_uint64,
prop_array_add_int8,
prop_array_add_uint8,
prop_array_add_int16,
prop_array_add_uint16,
prop_array_add_int32,
prop_array_add_uint32,
prop_array_add_int64,
prop_array_add_uint64,
prop_array_add_cstring,
prop_array_get_cstring,
prop_array_set_cstring,
prop_array_add_cstring_nocopy,
prop_array_get_cstring_nocopy,
prop_array_set_cstring_nocopy,
prop_array_add_and_rel —
array
property collection object utility functions
LIBRARY
Property Container Object Library (libprop, -lprop)
SYNOPSIS
#include <prop/proplib.h>
bool
prop_array_get_bool(
prop_array_t
dict,
unsigned int
indx,
bool *valp);
bool
prop_array_set_bool(
prop_array_t
dict,
unsigned int
indx,
bool val);
bool
prop_array_get_int8(
prop_array_t
dict,
unsigned int
indx,
int8_t *valp);
bool
prop_array_get_uint8(
prop_array_t
dict,
unsigned int
indx,
uint8_t *valp);
bool
prop_array_set_int8(
prop_array_t
dict,
unsigned int
indx,
int8_t val);
bool
prop_array_set_uint8(
prop_array_t
dict,
unsigned int
indx,
uint8_t val);
bool
prop_array_get_int16(
prop_array_t
dict,
unsigned int
indx,
int16_t *valp);
bool
prop_array_get_uint16(
prop_array_t
dict,
unsigned int
indx,
uint16_t
*valp);
bool
prop_array_set_int16(
prop_array_t
dict,
unsigned int
indx,
int16_t val);
bool
prop_array_set_uint16(
prop_array_t
dict,
unsigned int
indx,
uint16_t val);
bool
prop_array_get_int32(
prop_array_t
dict,
unsigned int
indx,
int32_t *valp);
bool
prop_array_get_uint32(
prop_array_t
dict,
unsigned int
indx,
uint32_t
*valp);
bool
prop_array_set_int32(
prop_array_t
dict,
unsigned int
indx,
int32_t val);
bool
prop_array_set_uint32(
prop_array_t
dict,
unsigned int
indx,
uint32_t val);
bool
prop_array_get_int64(
prop_array_t
dict,
unsigned int
indx,
int64_t *valp);
bool
prop_array_get_uint64(
prop_array_t
dict,
unsigned int
indx,
uint64_t
*valp);
bool
prop_array_set_int64(
prop_array_t
dict,
unsigned int
indx,
int64_t val);
bool
prop_array_set_uint64(
prop_array_t
dict,
unsigned int
indx,
uint64_t val);
bool
prop_array_set_int32(
prop_array_t
dict,
unsigned int
indx,
int32_t val);
bool
prop_array_set_uint32(
prop_array_t
dict,
unsigned int
indx,
uint32_t val);
bool
prop_array_add_int8(
prop_array_t
dict,
int8_t val);
bool
prop_array_add_uint8(
prop_array_t
dict,
uint8_t val);
bool
prop_array_add_int16(
prop_array_t
dict,
int16_t val);
bool
prop_array_add_uint16(
prop_array_t
dict,
uint16_t val);
bool
prop_array_add_int32(
prop_array_t
dict,
int32_t val);
bool
prop_array_add_uint32(
prop_array_t
dict,
uint32_t val);
bool
prop_array_add_int64(
prop_array_t
dict,
int64_t val);
bool
prop_array_add_uint64(
prop_array_t
dict,
uint64_t val);
bool
prop_array_add_cstring(
prop_array_t
dict,
const char
*cp);
bool
prop_array_get_cstring(
prop_array_t
dict,
unsigned int
indx,
char **strp);
bool
prop_array_set_cstring(
prop_array_t
dict,
unsigned int
indx,
const char
*str);
bool
prop_array_add_cstring_nocopy(
prop_array_t
dict,
const char
*cp);
bool
prop_array_get_cstring_nocopy(
prop_array_t
dict,
unsigned int
indx,
const char
**strp);
bool
prop_array_set_cstring_nocopy(
prop_array_t
dict,
unsigned int
indx,
const char
*strp);
bool
prop_array_add_and_rel(
prop_array_t
dict,
prop_object_t
obj);
DESCRIPTION
The
prop_array_util() family of functions are provided to make
getting and setting values in arrays more convenient in some applications.
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.
The setters handle object creation and release for the caller.
The
prop_array_add_cstring() and
prop_array_get_cstring() functions returns dynamically
allocated memory. See
prop_string(3) for more
information.
The
prop_array_add_cstring_nocopy(),
prop_array_get_cstring_nocopy(), and
prop_array_set_cstring_nocopy() functions do not copy the
string that is set or returned. See
prop_string(3) for more
information.
The
prop_array_add_and_rel() function adds the object to the
end of the array and releases it. The object is also released on failure.
RETURN VALUES
The
prop_array_util() getter functions return
true
if the object exists in the array and the value
is in-range, or
false
otherwise.
The
prop_array_util() setter functions return
true
if creating the object and storing it in the
array is successful, or
false
otherwise.
SEE ALSO
prop_array(3),
prop_bool(3),
prop_number(3),
proplib(3)
HISTORY
The
proplib(3) property container
object library first appeared in
NetBSD 4.0.