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