xref: /freebsd/contrib/elftoolchain/libdwarf/dwarf_diename.3 (revision ae500c1ff8974130f7f2692772cf288b90349e0d)
12de3b87aSKai Wang.\" Copyright (c) 2010 Kai Wang
22de3b87aSKai Wang.\" All rights reserved.
32de3b87aSKai Wang.\"
42de3b87aSKai Wang.\" Redistribution and use in source and binary forms, with or without
52de3b87aSKai Wang.\" modification, are permitted provided that the following conditions
62de3b87aSKai Wang.\" are met:
72de3b87aSKai Wang.\" 1. Redistributions of source code must retain the above copyright
82de3b87aSKai Wang.\"    notice, this list of conditions and the following disclaimer.
92de3b87aSKai Wang.\" 2. Redistributions in binary form must reproduce the above copyright
102de3b87aSKai Wang.\"    notice, this list of conditions and the following disclaimer in the
112de3b87aSKai Wang.\"    documentation and/or other materials provided with the distribution.
122de3b87aSKai Wang.\"
132de3b87aSKai Wang.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
142de3b87aSKai Wang.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
152de3b87aSKai Wang.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
162de3b87aSKai Wang.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
172de3b87aSKai Wang.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
182de3b87aSKai Wang.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
192de3b87aSKai Wang.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
202de3b87aSKai Wang.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
212de3b87aSKai Wang.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
222de3b87aSKai Wang.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
232de3b87aSKai Wang.\" SUCH DAMAGE.
242de3b87aSKai Wang.\"
25*ae500c1fSEd Maste.\" $Id: dwarf_diename.3 3644 2018-10-15 19:55:01Z jkoshy $
262de3b87aSKai Wang.\"
272de3b87aSKai Wang.Dd March 31, 2010
282de3b87aSKai Wang.Dt DWARF_DIENAME 3
29*ae500c1fSEd Maste.Os
302de3b87aSKai Wang.Sh NAME
312de3b87aSKai Wang.Nm dwarf_diename
322de3b87aSKai Wang.Nd retrieve the name associated with a debugging information entry
332de3b87aSKai Wang.Sh LIBRARY
342de3b87aSKai Wang.Lb libdwarf
352de3b87aSKai Wang.Sh SYNOPSIS
362de3b87aSKai Wang.In libdwarf.h
372de3b87aSKai Wang.Ft int
382de3b87aSKai Wang.Fn dwarf_diename "Dwarf_Die die" "char **ret_name" "Dwarf_Error *err"
392de3b87aSKai Wang.Sh DESCRIPTION
402de3b87aSKai WangFunction
412de3b87aSKai Wang.Fn dwarf_diename
422de3b87aSKai Wangretrieves a pointer to the NUL-terminated string associated with the
432de3b87aSKai Wang.Dv DW_AT_name
442de3b87aSKai Wangattribute of the debugging information entry descriptor referenced by
452de3b87aSKai Wangargument
462de3b87aSKai Wang.Ar die .
472de3b87aSKai WangIf the pointer was successfully retrieved, it is stored in the location
482de3b87aSKai Wangpointed to by argument
492de3b87aSKai Wang.Ar ret_name .
502de3b87aSKai Wang.Sh RETURN VALUES
512de3b87aSKai WangFunction
522de3b87aSKai Wang.Fn dwarf_diename
532de3b87aSKai Wangreturns
54*ae500c1fSEd Maste.Dv DW_DLV_OK
55*ae500c1fSEd Masteon success.
562de3b87aSKai Wang.Pp
572de3b87aSKai WangIf the debugging information entry descriptor denoted by argument
582de3b87aSKai Wang.Ar die
592de3b87aSKai Wangdoes not contain a
602de3b87aSKai Wang.Dv DW_AT_name
612de3b87aSKai Wangattribute, the function returns
622de3b87aSKai Wang.Dv DW_DLV_NO_ENTRY
632de3b87aSKai Wangand sets argument
642de3b87aSKai Wang.Ar err .
652de3b87aSKai WangFor other errors, it returns
662de3b87aSKai Wang.Dv DW_DLV_ERROR
672de3b87aSKai Wangand sets argument
682de3b87aSKai Wang.Ar err .
692de3b87aSKai Wang.Sh ERRORS
702de3b87aSKai WangFunction
712de3b87aSKai Wang.Fn dwarf_diename
722de3b87aSKai Wangcan fail with the following errors:
732de3b87aSKai Wang.Bl -tag -width ".Bq Er DW_DLE_ARGUMENT"
742de3b87aSKai Wang.It Bq Er DW_DLE_ARGUMENT
752de3b87aSKai WangEither of arguments
762de3b87aSKai Wang.Ar die
772de3b87aSKai Wangor
782de3b87aSKai Wang.Ar ret_name
792de3b87aSKai Wangwas NULL.
802de3b87aSKai Wang.It Bq Er DW_DLE_NO_ENTRY
812de3b87aSKai WangArgument
822de3b87aSKai Wang.Ar die
832de3b87aSKai Wanghad no
842de3b87aSKai Wang.Dv DW_AT_name
852de3b87aSKai Wangattribute.
862de3b87aSKai Wang.El
872de3b87aSKai Wang.Sh SEE ALSO
882de3b87aSKai Wang.Xr dwarf 3 ,
89*ae500c1fSEd Maste.Xr dwarf_die_abbrev_code 3 ,
902de3b87aSKai Wang.Xr dwarf_dieoffset 3 ,
91*ae500c1fSEd Maste.Xr dwarf_tag 3
92