1*5ac3bc71Schristos.\" $NetBSD: dwarf_formflag.3,v 1.6 2024/03/03 17:37:31 christos Exp $ 2e81373b4Schristos.\" 39dd9d0cfSchristos.\" Copyright (c) 2010 Joseph Koshy 49dd9d0cfSchristos.\" All rights reserved. 59dd9d0cfSchristos.\" 69dd9d0cfSchristos.\" Redistribution and use in source and binary forms, with or without 79dd9d0cfSchristos.\" modification, are permitted provided that the following conditions 89dd9d0cfSchristos.\" are met: 99dd9d0cfSchristos.\" 1. Redistributions of source code must retain the above copyright 109dd9d0cfSchristos.\" notice, this list of conditions and the following disclaimer. 119dd9d0cfSchristos.\" 2. Redistributions in binary form must reproduce the above copyright 129dd9d0cfSchristos.\" notice, this list of conditions and the following disclaimer in the 139dd9d0cfSchristos.\" documentation and/or other materials provided with the distribution. 149dd9d0cfSchristos.\" 159dd9d0cfSchristos.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 169dd9d0cfSchristos.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 179dd9d0cfSchristos.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 189dd9d0cfSchristos.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 199dd9d0cfSchristos.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 209dd9d0cfSchristos.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 219dd9d0cfSchristos.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 229dd9d0cfSchristos.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 239dd9d0cfSchristos.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 249dd9d0cfSchristos.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 259dd9d0cfSchristos.\" SUCH DAMAGE. 269dd9d0cfSchristos.\" 27cdbf1fe1Sjkoshy.\" Id: dwarf_formflag.3 3962 2022-03-12 15:56:10Z jkoshy 289dd9d0cfSchristos.\" 299dd9d0cfSchristos.Dd June 21, 2010 309dd9d0cfSchristos.Dt DWARF_FORMFLAG 3 31604b0842Sjkoshy.Os 329dd9d0cfSchristos.Sh NAME 339dd9d0cfSchristos.Nm dwarf_formflag 349dd9d0cfSchristos.Nd return the value of a BOOLEAN class attribute 359dd9d0cfSchristos.Sh LIBRARY 369dd9d0cfSchristos.Lb libdwarf 379dd9d0cfSchristos.Sh SYNOPSIS 389dd9d0cfSchristos.In libdwarf.h 399dd9d0cfSchristos.Ft int 409dd9d0cfSchristos.Fo dwarf_formflag 419dd9d0cfSchristos.Fa "Dwarf_Attribute attr" 429dd9d0cfSchristos.Fa "Dwarf_Bool *ret" 439dd9d0cfSchristos.Fa "Dwarf_Error *err" 449dd9d0cfSchristos.Fc 459dd9d0cfSchristos.Sh DESCRIPTION 469dd9d0cfSchristosFunction 479dd9d0cfSchristos.Fn dwarf_formflag 489dd9d0cfSchristossets the location pointed to by argument 49cdbf1fe1Sjkoshy.Fa ret 509dd9d0cfSchristosto 1 if the attribute referenced by argument 51cdbf1fe1Sjkoshy.Fa attr 529dd9d0cfSchristoshas a non-zero value, or 0 otherwise. 539dd9d0cfSchristosThe form of argument 54cdbf1fe1Sjkoshy.Fa attr 559dd9d0cfSchristosmust be one of 569dd9d0cfSchristos.Dv DW_FORM_flag 579dd9d0cfSchristosor 589dd9d0cfSchristos.Dv DW_FORM_flag_present . 599dd9d0cfSchristos.Pp 609dd9d0cfSchristosIf argument 61cdbf1fe1Sjkoshy.Fa err 62cdbf1fe1Sjkoshyis not 63cdbf1fe1Sjkoshy.Dv NULL , 64cdbf1fe1Sjkoshyit will be used to return an error descriptor in case of an error. 659dd9d0cfSchristos.Sh RETURN VALUES 669dd9d0cfSchristosFunction 679dd9d0cfSchristos.Fn dwarf_formflag 689dd9d0cfSchristosreturns 699dd9d0cfSchristos.Dv DW_DLV_OK 709dd9d0cfSchristoson success. 719dd9d0cfSchristosIn case of an error, it returns 729dd9d0cfSchristos.Dv DW_DLV_ERROR 739dd9d0cfSchristosand sets argument 74cdbf1fe1Sjkoshy.Fa err . 759dd9d0cfSchristos.Sh ERRORS 769dd9d0cfSchristosFunction 779dd9d0cfSchristos.Fn dwarf_formflag 789dd9d0cfSchristosmay fail with the following errors: 799dd9d0cfSchristos.Bl -tag -width ".Bq Er DW_DLE_ATTR_FORM_BAD" 809dd9d0cfSchristos.It Bq Er DW_DLE_ARGUMENT 819dd9d0cfSchristosEither of arguments 82cdbf1fe1Sjkoshy.Fa attr 839dd9d0cfSchristosor 84cdbf1fe1Sjkoshy.Fa ret 85cdbf1fe1Sjkoshywas 86cdbf1fe1Sjkoshy.Dv NULL . 879dd9d0cfSchristos.It Bq Er DW_DLE_ATTR_FORM_BAD 889dd9d0cfSchristosThe attribute referenced by argument 89cdbf1fe1Sjkoshy.Fa attr 909dd9d0cfSchristoswas not of a permitted kind. 919dd9d0cfSchristos.El 929dd9d0cfSchristos.Sh SEE ALSO 939dd9d0cfSchristos.Xr dwarf 3 , 949dd9d0cfSchristos.Xr dwarf_attr 3 , 959dd9d0cfSchristos.Xr dwarf_formblock 3 , 969dd9d0cfSchristos.Xr dwarf_formref 3 , 979dd9d0cfSchristos.Xr dwarf_formsdata 3 , 989dd9d0cfSchristos.Xr dwarf_formsig8 3 , 999dd9d0cfSchristos.Xr dwarf_formstring 3 , 1009dd9d0cfSchristos.Xr dwarf_formudata 3 , 1019dd9d0cfSchristos.Xr dwarf_hasattr 3 102