contrib/elftoolchain/libdwarf/dwarf_get_die_infotypes_flag.3

   1 .\" Copyright (c) 2014 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_get_die_infotypes_flag.3 3640 2018-10-14 14:09:13Z jkoshy $
  26 .\"
  27 .Dd December 20, 2014
  28 .Dt DWARF_GET_DIE_INFOTYPES_FLAG 3
  29 .Os
  30 .Sh NAME
  31 .Nm dwarf_get_die_infotypes_flag
  32 .Nd indicate the originating DWARF section for a DIE
  33 .Sh LIBRARY
  34 .Lb libdwarf
  35 .Sh SYNOPSIS
  36 .In libdwarf.h
  37 .Ft Dwarf_Bool
  38 .Fo dwarf_get_die_infotypes_flag
  39 .Fa "Dwarf_Die die"
  40 .Fc
  41 .Sh DESCRIPTION
  42 Function
  43 .Fn dwarf_get_die_infotypes_flag
  44 returns a flag indicating the originating DWARF section for the
  45 debugging information entry referenced by argument
  46 .Ar die .
  47 .Pp
  48 Argument
  49 .Ar die
  50 should reference a valid debugging information entry descriptor.
  51 .Sh RETURN VALUES
  52 Function
  53 .Fn dwarf_get_die_infotypes_flag
  54 returns a non-zero value if argument
  55 .Ar die
  56 originates in the
  57 .Dq .debug_info
  58 section.
  59 .Pp
  60 It returns zero if argument
  61 .Ar die
  62 originates in the
  63 .Dq .debug_types
  64 section.
  65 .Sh ERRORS
  66 Function
  67 .Fn dwarf_get_die_infotypes_flag
  68 always succeeds.
  69 .Sh SEE ALSO
  70 .Xr dwarf 3 ,
  71 .Xr dwarf_next_cu_header_c 3 ,
  72 .Xr dwarf_offdie_b 3 ,
  73 .Xr dwarf_siblingof_b 3