1.\" $NetBSD: prop_data.3,v 1.1 2006/04/27 20:11:27 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 const void * 67.Fn prop_data_data_nocopy "prop_data_t data" 68.\" 69.Ft boolean_t 70.Fn prop_data_equals "prop_data_t dat1" "prop_data_t dat2" 71.Ft boolean_t 72.Fn prop_data_equals_data "prop_data_t data" "const void *blob" "size_t len" 73.Sh DESCRIPTION 74The 75.Nm prop_data 76family of functions operate on an opaque data value property object type. 77.Bl -tag -width "xxxxx" 78.It Fn prop_data_create_data "const void *blob" "size_t len" 79Create a data object that contains a copy of 80.Fa blob 81with size 82.Fa len . 83.It Fn prop_data_create_data_nocopy "const void *blob" "size_t len" 84Create a data object that contains a reference to 85.Fa blob 86with size 87.Fa len . 88.It Fn prop_data_copy "prop_data_t data" 89Copy a data object. 90If the the data object being copied is an external data reference, 91then the copy also references the same external data. 92.It Fn prop_data_size "prop_data_t data" 93Returns the size of the data object. 94.It Fn prop_data_data "prop_data_t data" 95Returns a copy of the data object's contents. 96The caller is responsible for freeing the returned buffer. 97.Pp 98In user space, the buffer is allocated using 99.Xr malloc 3 . 100In the kernel, the buffer is allocated using 101.Xr malloc 9 102using the malloc type 103.Dv M_TEMP . 104.It Fn prop_data_data_nocopy "prop_data_t data" 105Returns an immutable reference to the contents of the data object. 106.It Fn prop_data_equals "prop_data_t dat1" "prop_data_t dat2" 107Returns 108.Dv TRUE 109if the two data objects are equivalent. 110.It Fn prop_data_equals_data "prop_data_t data" "const void *blob" "size_t len" 111Returns 112.Dv TRUE 113if the data object's value is equivalent to 114.Fa blob 115with size 116.Fa len . 117.El 118.Sh SEE ALSO 119.Xr prop_array 3 , 120.Xr prop_bool 3 , 121.Xr prop_dictionary 3 , 122.Xr prop_number 3 , 123.Xr prop_object 3 , 124.Xr prop_string 3 , 125.Xr proplib 3 126.Sh HISTORY 127The 128.Nm proplib 129property container object library first appeared in 130.Nx 4.0 . 131