1.\" $NetBSD: prop_bool.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_BOOL 3 39.Os 40.Sh NAME 41.Nm prop_bool , 42.Nm prop_bool_create , 43.Nm prop_bool_copy , 44.Nm prop_bool_true 45.Nd boolean value property object 46.Sh LIBRARY 47.Lb libprop 48.Sh SYNOPSIS 49.In prop/proplib.h 50.\" 51.Ft prop_bool_t 52.Fn prop_bool_create "boolean_t val" 53.Ft prop_bool_t 54.Fn prop_booly_copy "prop_bool_t bool" 55.\" 56.Ft boolean_t 57.Fn prop_bool_true "prop_bool_t bool" 58.Sh DESCRIPTION 59The 60.Nm prop_bool 61family of functions operate on a boolean value property object type. 62.Bl -tag -width "xxxxx" 63.It Fn prop_bool_create "boolean_t val" 64Create a boolean value object with the value 65.Fa val . 66.It Fn prop_bool_copy "prop_bool_t bool" 67Copy a boolean value object. 68.It Fn prop_bool_true "prop_bool_t bool" 69Returns the value of the boolean value object. 70.El 71.Sh SEE ALSO 72.Xr prop_array 3 , 73.Xr prop_data 3 , 74.Xr prop_dictionary 3 , 75.Xr prop_number 3 , 76.Xr prop_object 3 , 77.Xr prop_string 3 , 78.Xr proplib 3 79.Sh HISTORY 80The 81.Nm proplib 82property container object library first appeared in 83.Nx 4.0 . 84