Updated: 2025/Nov/16

Please read Privacy Policy. It's for your privacy.

PROP_OBJECT(3)             Library Functions Manual             PROP_OBJECT(3)

NAME
     prop_object, prop_object_retain, prop_object_release, prop_object_type,
     prop_object_equals, prop_object_iterator_next,
     prop_object_iterator_reset, prop_object_iterator_release,
     prop_object_externalize, prop_object_externalize_with_format,
     prop_object_externalize_to_file,
     prop_object_externalize_to_file_with_format, prop_object_internalize,
     prop_object_internalize_from_file - general property container object
     functions

LIBRARY
     Property Container Object Library (libprop, -lprop)

SYNOPSIS
     #include <prop/proplib.h>

     void
     prop_object_retain(prop_object_t obj);

     void
     prop_object_release(prop_object_t obj);

     prop_type_t
     prop_object_type(prop_object_t obj);

     bool
     prop_object_equals(prop_object_t obj1, prop_object_t obj2);

     prop_object_t
     prop_object_iterator_next(prop_object_iterator_t iter);

     void
     prop_object_iterator_reset(prop_object_iterator_t iter);

     void
     prop_object_iterator_release(prop_object_iterator_t iter);

     char *
     prop_object_externalize(prop_object_t obj);

     char *
     prop_object_externalize_with_format(prop_object_t obj,
         prop_format_t format);

     bool
     prop_object_externalize_to_file(prop_object_t obj, const char *path);

     bool
     prop_object_externalize_to_file_with_format(prop_object_t obj,
         const char *path, prop_format_t format);

     prop_object_t
     prop_object_internalize(const char *data);

     prop_object_t
     prop_object_internalize_from_file(const char *path);

DESCRIPTION
     The prop_object family of functions operate on all property container
     object types.

     prop_object_retain(prop_object_t obj)
       Increment the reference count on an object.

     prop_object_release(prop_object_t obj)
       Decrement the reference count on an object.  If the last reference is
       dropped, the object is freed.

     prop_object_type(prop_object_t obj)
       Determine the type of the object.  Objects are one of the following
       types:

       PROP_TYPE_BOOL         Boolean value (prop_bool_t)
       PROP_TYPE_NUMBER       Number (prop_number_t)
       PROP_TYPE_STRING       String (prop_string_t)
       PROP_TYPE_DATA         Opaque data (prop_data_t)
       PROP_TYPE_ARRAY        Array (prop_array_t)
       PROP_TYPE_DICTIONARY   Dictionary (prop_dictionary_t)
       PROP_TYPE_DICT_KEYSYM  Dictionary key symbol (prop_dictionary_keysym_t)

       If obj is NULL, then PROP_TYPE_UNKNOWN is returned.

     prop_object_equals(prop_object_t obj1, prop_object_t obj2)
       Returns true if the two objects are of the same type and are
       equivalent.

     prop_object_iterator_next(prop_object_iterator_t iter)
       Return the next object in the collection (array or dictionary) being
       iterated by the iterator iter.  If there are no more objects in the
       collection, NULL is returned.

     prop_object_iterator_reset(prop_object_iterator_t iter)
       Reset the iterator to the first object in the collection being iterated
       by the iterator iter.

     prop_object_iterator_release(prop_object_iterator_t iter)
       Release the iterator iter.

     prop_object_externalize(prop_object_t obj)
       Externalizes an object, returning a NUL-terminated buffer containing a
       representation of the object in the default format (XML property list).
       The caller is responsible for freeing the returned buffer.  If
       converting to the external representation fails for any reason, NULL is
       returned.

       In user space, the buffer is allocated using malloc(3).  In the kernel,
       the buffer is allocated using malloc(9) using the malloc type M_TEMP.

     prop_object_externalize_with_format(prop_object_t obj, prop_format_t
       format)
       Like prop_object_externalize(), except the output format is specified
       explicitly.  The following formats are supported:

       PROP_FORMAT_JSON  RFC 8259 JSON format
       PROP_FORMAT_XML   XML property list format

     prop_object_externalize_to_file(prop_object_t, const char *path)

     prop_object_externalize_to_file_with_format(prop_object_t, const char
       *path, prop_format_t format)
       Like prop_object_externalize() and
       prop_object_externalize_with_format(), except the external
       representation is written to the file specified by path.  The file is
       saved with the mode 0666 as modified by the process's file creation
       mask (see umask(2)) and is written atomically.  Returns false if
       externalizing the object or writing the file fails for any reason.

     prop_object_internalize(const char *data)
       Parses the external representation of an object in the NUL-terminated
       buffer data and returns the corresponding object.  The format of the
       external representation is detected automatically.  Returns NULL if
       parsing fails for any reason.

     prop_object_internalize_from_file(const char *path)

SEE ALSO
     prop_array(3), prop_bool(3), prop_data(3), prop_dictionary(3),
     prop_number(3), prop_string(3), proplib(3)

HISTORY
     The proplib(3) property container object library first appeared in
     NetBSD 4.0.

NetBSD 11.99                    April 20, 2025                    NetBSD 11.99