xref: /freebsd/contrib/elftoolchain/libdwarf/dwarf_add_AT_name.3 (revision 0b3105a37d7adcadcb720112fed4dc4e8040be99)
1.\" Copyright (c) 2011 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_add_AT_name.3 2072 2011-10-27 03:26:49Z jkoshy $
26.\"
27.Dd September 4, 2011
28.Os
29.Dt DWARF_ADD_AT_NAME 3
30.Sh NAME
31.Nm dwarf_add_AT_name
32.Nd create and attach a DW_AT_name attribute
33.Sh LIBRARY
34.Lb libdwarf
35.Sh SYNOPSIS
36.In libdwarf.h
37.Ft Dwarf_P_Attribute
38.Fo dwarf_add_AT_name
39.Fa "Dwarf_P_Die die"
40.Fa "char *name"
41.Fa "Dwarf_Error *err"
42.Fc
43.Sh DESCRIPTION
44Function
45.Fn dwarf_add_AT_name
46creates a
47.Dv DW_AT_name
48attribute descriptor and attaches it to the debugging information
49entry referenced by argument
50.Ar die .
51The created attribute will have DWARF form
52.Dv DW_FORM_strp .
53.Pp
54Argument
55.Ar die
56should reference a debugging information entry allocated using
57.Xr dwarf_new_die 3 .
58.Pp
59Argument
60.Ar name
61should point to a NUL-terminated string which will become the value of
62the created attribute.
63.Pp
64If argument
65.Ar err
66is not NULL, it will be used to store error information in case
67of an error.
68.Sh RETURN VALUES
69On success, function
70.Fn dwarf_add_AT_name
71returns the created attribute descriptor.
72In case of an error, function
73.Fn dwarf_add_AT_name
74returns
75.Dv DW_DLV_BADADDR
76and sets the argument
77.Ar err .
78.Sh ERRORS
79Function
80.Fn dwarf_add_AT_name
81can fail with:
82.Bl -tag -width ".Bq Er DW_DLE_ARGUMENT"
83.It Bq Er DW_DLE_ARGUMENT
84One of the arguments
85.Ar die
86or
87.Ar name
88was NULL.
89.It Bq Er DW_DLE_MEMORY
90An out of memory condition was encountered during the execution of
91this function.
92.El
93.Sh SEE ALSO
94.Xr dwarf 3 ,
95.Xr dwarf_add_AT_comp_dir 3 ,
96.Xr dwarf_add_AT_const_value_string 3 ,
97.Xr dwarf_add_AT_producer 3 ,
98.Xr dwarf_add_AT_string 3 ,
99.Xr dwarf_new_die 3
100