1.\"	$NetBSD: dwarf_formflag.3,v 1.2 2014/03/09 16:58:03 christos Exp $
2.\"
3.\" Copyright (c) 2010 Joseph Koshy
4.\" All rights reserved.
5.\"
6.\" Redistribution and use in source and binary forms, with or without
7.\" modification, are permitted provided that the following conditions
8.\" are met:
9.\" 1. Redistributions of source code must retain the above copyright
10.\"    notice, this list of conditions and the following disclaimer.
11.\" 2. Redistributions in binary form must reproduce the above copyright
12.\"    notice, this list of conditions and the following disclaimer in the
13.\"    documentation and/or other materials provided with the distribution.
14.\"
15.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25.\" SUCH DAMAGE.
26.\"
27.\" Id: dwarf_formflag.3 2073 2011-10-27 03:30:47Z jkoshy
28.\"
29.Dd June 21, 2010
30.Os
31.Dt DWARF_FORMFLAG 3
32.Sh NAME
33.Nm dwarf_formflag
34.Nd return the value of a BOOLEAN class attribute
35.Sh LIBRARY
36.Lb libdwarf
37.Sh SYNOPSIS
38.In libdwarf.h
39.Ft int
40.Fo dwarf_formflag
41.Fa "Dwarf_Attribute attr"
42.Fa "Dwarf_Bool *ret"
43.Fa "Dwarf_Error *err"
44.Fc
45.Sh DESCRIPTION
46Function
47.Fn dwarf_formflag
48sets the location pointed to by argument
49.Ar ret
50to 1 if the attribute referenced by argument
51.Ar attr
52has a non-zero value, or 0 otherwise.
53The form of argument
54.Ar attr
55must be one of
56.Dv DW_FORM_flag
57or
58.Dv DW_FORM_flag_present .
59.Pp
60If argument
61.Ar err
62is not NULL, it will be used to return an error descriptor in case
63of an error.
64.Sh RETURN VALUES
65Function
66.Fn dwarf_formflag
67returns
68.Dv DW_DLV_OK
69on success.
70In case of an error, it returns
71.Dv DW_DLV_ERROR
72and sets argument
73.Ar err .
74.Sh ERRORS
75Function
76.Fn dwarf_formflag
77may fail with the following errors:
78.Bl -tag -width ".Bq Er DW_DLE_ATTR_FORM_BAD"
79.It Bq Er DW_DLE_ARGUMENT
80Either of arguments
81.Ar attr
82or
83.Ar ret
84was NULL.
85.It Bq Er DW_DLE_ATTR_FORM_BAD
86The attribute referenced by argument
87.Ar attr
88was not of a permitted kind.
89.El
90.Sh SEE ALSO
91.Xr dwarf 3 ,
92.Xr dwarf_attr 3 ,
93.Xr dwarf_formblock 3 ,
94.Xr dwarf_formref 3 ,
95.Xr dwarf_formsdata 3 ,
96.Xr dwarf_formsig8 3 ,
97.Xr dwarf_formstring 3 ,
98.Xr dwarf_formudata 3 ,
99.Xr dwarf_hasattr 3
100