prop_data_create_data_nocopy(3) [netbsd man page]

PROP_DATA(3)						   BSD Library Functions Manual 					      PROP_DATA(3)

NAME

     prop_data, prop_data_create_data, prop_data_create_data_nocopy, prop_data_copy, prop_data_size, prop_data_data, prop_data_data_nocopy,
     prop_data_equals, prop_data_equals_data -- opaque data value property object

LIBRARY

     Property Container Object Library (libprop, -lprop)

SYNOPSIS

     #include <prop/proplib.h>

     prop_data_t
     prop_data_create_data(const void *blob, size_t len);

     prop_data_t
     prop_data_create_data_nocopy(const void *blob, size_t len);

     prop_data_t
     prop_data_copy(prop_data_t data);

     size_t
     prop_data_size(prop_data_t data);

     void *
     prop_data_data(prop_data_t data);

     const void *
     prop_data_data_nocopy(prop_data_t data);

     bool
     prop_data_equals(prop_data_t dat1, prop_data_t dat2);

     bool
     prop_data_equals_data(prop_data_t data, const void *blob, size_t len);

DESCRIPTION

     The prop_data family of functions operate on an opaque data value property object type.

     prop_data_create_data(const void *blob, size_t len)
	    Create a data object that contains a copy of blob with size len.  Returns NULL on failure.

     prop_data_create_data_nocopy(const void *blob, size_t len)
	    Create a data object that contains a reference to blob with size len.  Returns NULL on failure.

     prop_data_copy(prop_data_t data)
	    Copy a data object.  If the data object being copied is an external data reference, then the copy also references the same external
	    data.  Returns NULL on failure.

     prop_data_size(prop_data_t data)
	    Returns the size of the data object.  If the supplied object isn't a data object, zero is returned.

     prop_data_data(prop_data_t data)
	    Returns a copy of the data object's contents.  The caller is responsible for freeing the returned buffer.  If the supplied object
	    isn't a data object or if the data container is empty, 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_data_data_nocopy(prop_data_t data)
	    Returns an immutable reference to the contents of the data object.	If the supplied object isn't a data object, NULL is returned.

     prop_data_equals(prop_data_t dat1, prop_data_t dat2)
	    Returns true if the two data objects are equivalent.  If at least one of the supplied objects isn't a data object, false is returned.

     prop_data_equals_data(prop_data_t data, const void *blob, size_t len)
	    Returns true if the data object's value is equivalent to blob with size len.  If the supplied object isn't a data object, false is
	    returned.

SEE ALSO

     prop_array(3), prop_bool(3), prop_dictionary(3), prop_number(3), prop_object(3), prop_string(3), proplib(3)

HISTORY

     The proplib property container object library first appeared in NetBSD 4.0.

BSD
								  April 22, 2006							       BSD

Check Out this Related Man Page

PROP_OBJECT(3)						   BSD 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 -- 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);

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.

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 property container object library first appeared in NetBSD 4.0.

BSD
								  August 21, 2006							       BSD

Linux and UNIX Man Pages

prop_data_create_data_nocopy(3) [netbsd man page]

Check Out this Related Man Page