1.\" $NetBSD: prop_data.3,v 1.4 2007/08/16 16:31:00 thorpej Exp $ 2.\" 3.\" Copyright (c) 2006 The NetBSD Foundation, Inc. 4.\" All rights reserved. 5.\" 6.\" This code is derived from software contributed to The NetBSD Foundation 7.\" by Jason R. Thorpe. 8.\" 9.\" Redistribution and use in source and binary forms, with or without 10.\" modification, are permitted provided that the following conditions 11.\" are met: 12.\" 1. Redistributions of source code must retain the above copyright 13.\" notice, this list of conditions and the following disclaimer. 14.\" 2. Redistributions in binary form must reproduce the above copyright 15.\" notice, this list of conditions and the following disclaimer in the 16.\" documentation and/or other materials provided with the distribution. 17.\" 3. All advertising materials mentioning features or use of this software 18.\" must display the following acknowledgement: 19.\" This product includes software developed by the NetBSD 20.\" Foundation, Inc. and its contributors. 21.\" 4. Neither the name of The NetBSD Foundation nor the names of its 22.\" contributors may be used to endorse or promote products derived 23.\" from this software without specific prior written permission. 24.\" 25.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 26.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 27.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 28.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 29.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 30.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 31.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 32.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 33.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 34.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 35.\" POSSIBILITY OF SUCH DAMAGE. 36.\" 37.Dd April 22, 2006 38.Dt PROP_DATA 3 39.Os 40.Sh NAME 41.Nm prop_data , 42.Nm prop_data_create_data , 43.Nm prop_data_create_data_nocopy , 44.Nm prop_data_copy , 45.Nm prop_data_size , 46.Nm prop_data_data , 47.Nm prop_data_data_nocopy , 48.Nm prop_data_equals , 49.Nm prop_data_equals_data 50.Nd opaque data value property object 51.Sh LIBRARY 52.Lb libprop 53.Sh SYNOPSIS 54.In prop/proplib.h 55.\" 56.Ft prop_data_t 57.Fn prop_data_create_data "const void *blob" "size_t len" 58.Ft prop_data_t 59.Fn prop_data_create_data_nocopy "const void *blob" "size_t len" 60.\" 61.Ft prop_data_t 62.Fn prop_data_copy "prop_data_t data" 63.\" 64.Ft void * 65.Fn prop_data_data "prop_data_t data" 66.Ft size_t 67.Fn prop_data_size "prop_data_t data" 68.Ft const void * 69.Fn prop_data_data_nocopy "prop_data_t data" 70.\" 71.Ft bool 72.Fn prop_data_equals "prop_data_t dat1" "prop_data_t dat2" 73.Ft bool 74.Fn prop_data_equals_data "prop_data_t data" "const void *blob" "size_t len" 75.Sh DESCRIPTION 76The 77.Nm prop_data 78family of functions operate on an opaque data value property object type. 79.Bl -tag -width "xxxxx" 80.It Fn prop_data_create_data "const void *blob" "size_t len" 81Create a data object that contains a copy of 82.Fa blob 83with size 84.Fa len . 85.It Fn prop_data_create_data_nocopy "const void *blob" "size_t len" 86Create a data object that contains a reference to 87.Fa blob 88with size 89.Fa len . 90.It Fn prop_data_copy "prop_data_t data" 91Copy a data object. 92If the the data object being copied is an external data reference, 93then the copy also references the same external data. 94.It Fn prop_data_size "prop_data_t data" 95Returns the size of the data object. 96.It Fn prop_data_data "prop_data_t data" 97Returns a copy of the data object's contents. 98The caller is responsible for freeing the returned buffer. 99.Pp 100In user space, the buffer is allocated using 101.Xr malloc 3 . 102In the kernel, the buffer is allocated using 103.Xr malloc 9 104using the malloc type 105.Dv M_TEMP . 106.It Fn prop_data_data_nocopy "prop_data_t data" 107Returns an immutable reference to the contents of the data object. 108.It Fn prop_data_equals "prop_data_t dat1" "prop_data_t dat2" 109Returns 110.Dv true 111if the two data objects are equivalent. 112.It Fn prop_data_equals_data "prop_data_t data" "const void *blob" "size_t len" 113Returns 114.Dv true 115if the data object's value is equivalent to 116.Fa blob 117with size 118.Fa len . 119.El 120.Sh SEE ALSO 121.Xr prop_array 3 , 122.Xr prop_bool 3 , 123.Xr prop_dictionary 3 , 124.Xr prop_number 3 , 125.Xr prop_object 3 , 126.Xr prop_string 3 , 127.Xr proplib 3 128.Sh HISTORY 129The 130.Nm proplib 131property container object library first appeared in 132.Nx 4.0 . 133