external/bsd/elftoolchain/dist/libdwarf/dwarf_get_abbrev_children_flag.3

   1 .\"     $NetBSD: dwarf_get_abbrev_children_flag.3,v 1.2 2014/03/09 16:58:03 christos Exp $
   2 .\"
   3 .\" Copyright (c) 2011 Kai Wang
   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_get_abbrev_children_flag.3 2071 2011-10-27 03:20:00Z jkoshy
  28 .\"
  29 .Dd March 14, 2011
  30 .Os
  31 .Dt DWARF_GET_ABBREV_CHILDREN_FLAG 3
  32 .Sh NAME
  33 .Nm dwarf_get_abbrev_children_flag
  34 .Nd return a flag indicating the presence of children
  35 .Sh LIBRARY
  36 .Lb libdwarf
  37 .Sh SYNOPSIS
  38 .In libdwarf.h
  39 .Ft int
  40 .Fo dwarf_get_abbrev_children_flag
  41 .Fa "Dwarf_Abbrev abbrev"
  42 .Fa "Dwarf_Signed *ret"
  43 .Fa "Dwarf_Error *err"
  44 .Fc
  45 .Sh DESCRIPTION
  46 Function
  47 .Fn dwarf_get_abbrev_children_flag
  48 retrieves a flag indicating whether the DWARF debug information entry
  49 associated with a DWARF abbreviation descriptor has child entries.
  50 .Pp
  51 Argument
  52 .Ar abbrev
  53 should be a valid DWARF abbreviation descriptor, as returned by
  54 .Xr dwarf_get_abbrev 3 .
  55 .Pp
  56 Argument
  57 .Ar ret
  58 should point to a location which will hold the returned
  59 flag.
  60 The value returned will be one of the following:
  61 .Bl -tag -width ".Dv DW_CHILDREN_yes" -compact
  62 .It Dv DW_CHILDREN_yes
  63 The debugging information entry associated with the
  64 specified abbreviation descriptor has children.
  65 .It Dv DW_CHILDREN_no
  66 The debugging information entry associated with the
  67 specified abbreviation descriptor has no children.
  68 .El
  69 .Pp
  70 If argument
  71 .Ar err
  72 is not NULL, it will be used to store error information in case of an
  73 error.
  74 .Pp
  75 .Sh RETURN VALUES
  76 Function
  77 .Fn dwarf_get_abbrev_children_flag
  78 returns
  79 .Dv DW_DLV_OK
  80 when it succeeds.
  81 In case of an error, it returns
  82 .Dv DW_DLV_ERROR
  83 and sets the argument
  84 .Ar err .
  85 .Sh ERRORS
  86 Function
  87 .Fn dwarf_get_abbrev_children_flag
  88 can fail with:
  89 .Bl -tag -width ".Bq Er DW_DLE_ARGUMENT"
  90 .It Bq Er DW_DLE_ARGUMENT
  91 Either of arguments
  92 .Ar abbrev
  93 or
  94 .Ar ret
  95 was NULL.
  96 .El
  97 .Sh SEE ALSO
  98 .Xr dwarf 3 ,
  99 .Xr dwarf_get_abbrev 3 ,
 100 .Xr dwarf_get_abbrev_code 3 ,
 101 .Xr dwarf_get_abbrev_tag 3 ,
 102 .Xr dwarf_get_abbrev_entry 3