1.\"	$NetBSD: dwarf_formaddr.3,v 1.2 2014/03/09 16:58:03 christos Exp $
2.\"
3.\" Copyright (c) 2010 Joseph Koshy
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_formaddr.3 2073 2011-10-27 03:30:47Z jkoshy
28.\"
29.Dd July 23, 2010
30.Os
31.Dt DWARF_FORMADDR 3
32.Sh NAME
33.Nm dwarf_formaddr
34.Nd return the value of an ADDRESS class attribute
35.Sh LIBRARY
36.Lb libdwarf
37.Sh SYNOPSIS
38.In libdwarf.h
39.Ft int
40.Fo dwarf_formaddr
41.Fa "Dwarf_Attribute attr"
42.Fa "Dwarf_Addr *ret"
43.Fa "Dwarf_Error *err"
44.Fc
45.Sh DESCRIPTION
46Function
47.Fn dwarf_formaddr
48sets the location pointed to by argument
49.Ar ret
50to the address represented by the attribute referenced
51by argument
52.Ar attr .
53The form of argument
54.Ar attr
55must be
56.Dv DW_FORM_addr .
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.Sh RETURN VALUES
63Function
64.Fn dwarf_formaddr
65returns
66.Dv DW_DLV_OK
67on success.
68In case of an error, it returns
69.Dv DW_DLV_ERROR
70and sets argument
71.Ar err .
72.Sh ERRORS
73Function
74.Fn dwarf_formblock
75may fail with the following errors:
76.Bl -tag -width ".Bq Er DW_DLE_ATTR_FORM_BAD"
77.It Bq Er DW_DLE_ARGUMENT
78Either of arguments
79.Ar attr
80or
81.Ar ret
82was NULL.
83.It Bq Er DW_DLE_ATTR_FORM_BAD
84The attribute referenced by argument
85.Ar attr
86was not of form
87.Dv DW_FORM_addr .
88.El
89.Sh SEE ALSO
90.Xr dwarf 3 ,
91.Xr dwarf_attr 3 ,
92.Xr dwarf_formblock 3 ,
93.Xr dwarf_formflag 3 ,
94.Xr dwarf_formref 3 ,
95.Xr dwarf_formsdata 3 ,
96.Xr dwarf_formsig8 3 ,
97.Xr dwarf_formstring 3 ,
98.Xr dwarf_formudata 3 ,
99.Xr dwarf_hasattr 3
100