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