contrib/elftoolchain/libdwarf/dwarf_hasattr.3

   1 .\" Copyright (c) 2010 Kai Wang
   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_hasattr.3 3640 2018-10-14 14:09:13Z jkoshy $
  26 .\"
  27 .Dd April 17, 2010
  28 .Dt DWARF_HASATTR 3
  29 .Os
  30 .Sh NAME
  31 .Nm dwarf_hasattr
  32 .Nd check for the presence of an attribute
  33 .Sh LIBRARY
  34 .Lb libdwarf
  35 .Sh SYNOPSIS
  36 .In libdwarf.h
  37 .Ft int
  38 .Fo dwarf_hasattr
  39 .Fa "Dwarf_Die die"
  40 .Fa "Dwarf_Half attr"
  41 .Fa "Dwarf_Bool *ret_bool"
  42 .Fa "Dwarf_Error *err"
  43 .Fc
  44 .Sh DESCRIPTION
  45 Function
  46 .Fn dwarf_hasattr
  47 tests whether the debugging information entry referenced in argument
  48 .Ar die
  49 contains the attribute named by argument
  50 .Ar attr .
  51 Legal values for argument
  52 .Ar attr
  53 are those denoted by the
  54 .Dv DW_AT_*
  55 constants in the DWARF specification.
  56 .Pp
  57 If the named attribute is present in the debugging information entry,
  58 function
  59 .Fn dwarf_hasattr
  60 returns a non-zero value in the location pointed to by argument
  61 .Ar ret_bool .
  62 If the named attribute is not present, a zero is written instead.
  63 .Pp
  64 If argument
  65 .Ar err
  66 is not NULL, it will be used to return an error descriptor in case
  67 of an error.
  68 .Sh RETURN VALUES
  69 On success, function
  70 .Fn dwarf_hasattr
  71 returns
  72 .Dv DW_DLV_OK .
  73 In case of an error, it returns
  74 .Dv DW_DLV_ERROR
  75 and sets argument
  76 .Ar err .
  77 .Sh ERRORS
  78 Function
  79 .Fn dwarf_hasattr
  80 can fail with the following error:
  81 .Bl -tag -width ".Bq Er DW_DLE_ARGUMENT"
  82 .It Bq Er DW_DLE_ARGUMENT
  83 Either of argument
  84 .Va die
  85 or
  86 .Va ret_bool
  87 was NULL.
  88 .El
  89 .Sh SEE ALSO
  90 .Xr dwarf 3 ,
  91 .Xr dwarf_attr 3 ,
  92 .Xr dwarf_whatattr 3