contrib/elftoolchain/libdwarf/dwarf_diename.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_diename.3 3644 2018-10-15 19:55:01Z jkoshy $
  26 .\"
  27 .Dd March 31, 2010
  28 .Dt DWARF_DIENAME 3
  29 .Os
  30 .Sh NAME
  31 .Nm dwarf_diename
  32 .Nd retrieve the name associated with a debugging information entry
  33 .Sh LIBRARY
  34 .Lb libdwarf
  35 .Sh SYNOPSIS
  36 .In libdwarf.h
  37 .Ft int
  38 .Fn dwarf_diename "Dwarf_Die die" "char **ret_name" "Dwarf_Error *err"
  39 .Sh DESCRIPTION
  40 Function
  41 .Fn dwarf_diename
  42 retrieves a pointer to the NUL-terminated string associated with the
  43 .Dv DW_AT_name
  44 attribute of the debugging information entry descriptor referenced by
  45 argument
  46 .Ar die .
  47 If the pointer was successfully retrieved, it is stored in the location
  48 pointed to by argument
  49 .Ar ret_name .
  50 .Sh RETURN VALUES
  51 Function
  52 .Fn dwarf_diename
  53 returns
  54 .Dv DW_DLV_OK
  55 on success.
  56 .Pp
  57 If the debugging information entry descriptor denoted by argument
  58 .Ar die
  59 does not contain a
  60 .Dv DW_AT_name
  61 attribute, the function returns
  62 .Dv DW_DLV_NO_ENTRY
  63 and sets argument
  64 .Ar err .
  65 For other errors, it returns
  66 .Dv DW_DLV_ERROR
  67 and sets argument
  68 .Ar err .
  69 .Sh ERRORS
  70 Function
  71 .Fn dwarf_diename
  72 can fail with the following errors:
  73 .Bl -tag -width ".Bq Er DW_DLE_ARGUMENT"
  74 .It Bq Er DW_DLE_ARGUMENT
  75 Either of arguments
  76 .Ar die
  77 or
  78 .Ar ret_name
  79 was NULL.
  80 .It Bq Er DW_DLE_NO_ENTRY
  81 Argument
  82 .Ar die
  83 had no
  84 .Dv DW_AT_name
  85 attribute.
  86 .El
  87 .Sh SEE ALSO
  88 .Xr dwarf 3 ,
  89 .Xr dwarf_die_abbrev_code 3 ,
  90 .Xr dwarf_dieoffset 3 ,
  91 .Xr dwarf_tag 3