lib/libprop/prop_bool.3

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