1.\" $NetBSD: prop_bool.3,v 1.8 2020/06/06 21:25:59 thorpej Exp $ 2.\" 3.\" Copyright (c) 2006, 2020 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.\" 18.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 19.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 20.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 21.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 22.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 23.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 24.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 25.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 26.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 27.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 28.\" POSSIBILITY OF SUCH DAMAGE. 29.\" 30.Dd June 2, 2020 31.Dt PROP_BOOL 3 32.Os 33.Sh NAME 34.Nm prop_bool , 35.Nm prop_bool_create , 36.Nm prop_bool_copy , 37.Nm prop_bool_true , 38.Nm prop_bool_value 39.Nd boolean value property object 40.Sh LIBRARY 41.Lb libprop 42.Sh SYNOPSIS 43.In prop/proplib.h 44.\" 45.Ft prop_bool_t 46.Fn prop_bool_create "bool val" 47.Ft prop_bool_t 48.Fn prop_bool_copy "prop_bool_t bool" 49.\" 50.Ft bool 51.Fn prop_bool_true "prop_bool_t bool" 52.Ft bool 53.Fn prop_bool_value "prop_bool_t bool" 54.Sh DESCRIPTION 55The 56.Nm 57family of functions operate on a boolean value property object type. 58.Bl -tag -width "xxxxx" 59.It Fn prop_bool_create "bool val" 60Create a boolean value object with the value 61.Fa val . 62.It Fn prop_bool_copy "prop_bool_t bool" 63Copy a boolean value object. 64If the supplied object isn't a boolean, 65.Dv NULL 66is returned. 67.It Fn prop_bool_true "prop_bool_t bool" 68.It Fn prop_bool_value "prop_bool_t bool" 69Returns the value of the boolean value object. 70Both functions are equivalent. 71If the supplied object isn't a boolean, 72.Dv false 73is returned. 74.El 75.Sh SEE ALSO 76.Xr prop_array 3 , 77.Xr prop_data 3 , 78.Xr prop_dictionary 3 , 79.Xr prop_number 3 , 80.Xr prop_object 3 , 81.Xr prop_string 3 , 82.Xr proplib 3 83.Sh HISTORY 84The 85.Xr proplib 3 86property container object library first appeared in 87.Nx 4.0 . 88