1.\"	$NetBSD: dwarf_add_AT_string.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_add_AT_string.3 2072 2011-10-27 03:26:49Z jkoshy
28.\"
29.Dd September 4, 2011
30.Os
31.Dt DWARF_ADD_AT_STRING 3
32.Sh NAME
33.Nm dwarf_add_AT_string
34.Nd create and attach a string class attribute
35.Sh LIBRARY
36.Lb libdwarf
37.Sh SYNOPSIS
38.In libdwarf.h
39.Ft Dwarf_P_Attribute
40.Fo dwarf_add_AT_string
41.Fa "Dwarf_P_Debug dbg"
42.Fa "Dwarf_P_Die die"
43.Fa "Dwarf_Half attr"
44.Fa "char *str"
45.Fa "Dwarf_Error *err"
46.Fc
47.Sh DESCRIPTION
48Function
49.Fn dwarf_add_AT_string
50creates an attribute descriptor belonging to the
51.Sq string
52class and attaches it to the debugging information entry referenced by
53argument
54.Ar die .
55The created attribute descriptor will have DWARF form
56.Dv DW_FORM_strp .
57.Pp
58Argument
59.Ar dbg
60should reference a DWARF producer instance allocated using
61.Xr dwarf_producer_init 3
62or
63.Xr dwarf_producer_init_b 3 .
64.Pp
65Argument
66.Ar die
67should reference a debugging information entry allocated using
68.Xr dwarf_new_die 3 .
69.Pp
70Argument
71.Ar attr
72should specify the attribute code for the created attribute
73descriptor.
74.Pp
75Argument
76.Ar str
77should hold a pointer to a NUL-terminated string which will become the
78value of the created attribute descriptor.
79.Pp
80If argument
81.Ar err
82is not NULL, it will be used to store error information in case of an
83error.
84.Sh RETURN VALUES
85On success, function
86.Fn dwarf_add_AT_string
87returns the created attribute descriptor.
88In case of an error, function
89.Fn dwarf_add_AT_string
90returns
91.Dv DW_DLV_BADADDR
92and sets the argument
93.Ar err .
94.Sh ERRORS
95Function
96.Fn dwarf_add_AT_string
97can fail with:
98.Bl -tag -width ".Bq Er DW_DLE_ARGUMENT"
99.It Bq Er DW_DLE_ARGUMENT
100One of the arguments
101.Ar dbg ,
102.Ar die
103or
104.Ar str
105was NULL.
106.It Bq Er DW_DLE_MEMORY
107An out of memory condition was encountered during the execution of
108the function.
109.El
110.Sh SEE ALSO
111.Xr dwarf 3 ,
112.Xr dwarf_add_AT_const_value_string 3 ,
113.Xr dwarf_add_AT_name 3 ,
114.Xr dwarf_new_die 3 ,
115.Xr dwarf_producer_init 3 ,
116.Xr dwarf_producer_init_b 3
117