contrib/elftoolchain/libdwarf/dwarf_formflag.3

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