1.\" Copyright (c) 2010 Joseph Koshy
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_formstring.3 2073 2011-10-27 03:30:47Z jkoshy $
26.\"
27.Dd July 24, 2010
28.Os
29.Dt DWARF_FORMSTRING 3
30.Sh NAME
31.Nm dwarf_formstring
32.Nd return the value of a STRING class attribute
33.Sh LIBRARY
34.Lb libdwarf
35.Sh SYNOPSIS
36.In libdwarf.h
37.Ft int
38.Fo dwarf_formstring
39.Fa "Dwarf_Attribute attr"
40.Fa "char **ret"
41.Fa "Dwarf_Error *err"
42.Fc
43.Sh DESCRIPTION
44Function
45.Fn dwarf_formstring
46sets the location pointed to by argument
47.Ar ret
48to a pointer to a NUL-terminated string containing
49the value of the attribute referenced by argument
50.Ar attr .
51The form of argument
52.Ar attr
53must be one of
54.Dv DW_FORM_string
55or
56.Dv DW_FORM_strp .
57.Pp
58If argument
59.Ar err
60is not NULL, it will be used to return an error descriptor in case
61of an error.
62.Ss Memory Management
63The memory area referenced by the returned pointer is managed by
64the DWARF(3) library.
65The application should not attempt to directly free this memory
66area.
67.Sh RETURN VALUES
68Function
69.Fn dwarf_formstring
70returns
71.Dv DW_DLV_OK
72on success.
73In case of an error, it returns
74.Dv DW_DLV_ERROR
75and sets argument
76.Ar err .
77.Sh ERRORS
78Function
79.Fn dwarf_formstring
80may fail with the following errors:
81.Bl -tag -width ".Bq Er DW_DLE_ATTR_FORM_BAD"
82.It Bq Er DW_DLE_ARGUMENT
83Either of arguments
84.Ar attr
85or
86.Ar ret
87was NULL.
88.It Bq Er DW_DLE_ATTR_FORM_BAD
89The attribute referenced by argument
90.Ar attr
91was not of a permitted kind.
92.El
93.Sh SEE ALSO
94.Xr dwarf 3 ,
95.Xr dwarf_attr 3 ,
96.Xr dwarf_formblock 3 ,
97.Xr dwarf_formref 3 ,
98.Xr dwarf_formsdata 3 ,
99.Xr dwarf_formsig8 3 ,
100.Xr dwarf_formudata 3 ,
101.Xr dwarf_hasattr 3
102