1.\" Copyright (c) 2014 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_attroffset.3 3115 2014-12-20 18:26:46Z jkoshy $
26.\"
27.Dd December 20, 2014
28.Os
29.Dt DWARF_ATTROFFSET 3
30.Sh NAME
31.Nm dwarf_attroffset
32.Nd retrieve the section-relative offset of an attribute descriptor
33.Sh LIBRARY
34.Lb libdwarf
35.Sh SYNOPSIS
36.In libdwarf.h
37.Ft int
38.Fo dwarf_attroffset
39.Fa "Dwarf_Attribute at"
40.Fa "Dwarf_Off *ret_off"
41.Fa "Dwarf_Error *err"
42.Fc
43.Sh DESCRIPTION
44Function
45.Fn dwarf_attroffset
46retrieves the section-relative offset of the attribute descriptor
47referenced by argument
48.Ar at .
49.Pp
50Argument
51.Ar ret_off
52should point to a location that is to hold the returned
53section-relative offset.
54If argument
55.Ar err
56is non-NULL, it is used to return an error descriptor in case of an
57error.
58.Sh RETURN VALUES
59On success, function
60.Fn dwarf_attroffset
61returns
62.Dv DW_DLV_OK .
63.Pp
64In case of an error, it returns
65.Dv DW_DLV_ERROR
66and sets argument
67.Ar err .
68.Sh COMPATIBILITY
69This function is an extension to the
70.Xr DWARF 3
71API.
72.Sh ERRORS
73The
74.Fn dwarf_attroffset
75function may fail with the following errors:
76.Bl -tag -width ".Bq Er DW_DLE_ARGUMENT"
77.It Bq Er DW_DLE_ARGUMENT
78Either of the arguments
79.Ar at
80or
81.Ar ret_off
82was NULL.
83.El
84.Sh SEE ALSO
85.Xr dwarf 3 ,
86.Xr dwarf_attr 3
87