1.\" $NetBSD: dwarf_attroffset.3,v 1.5 2024/03/03 17:37:30 christos 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 3961 2022-03-12 15:13:22Z 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.Fa at . 51.Pp 52Argument 53.Fa ret_off 54should point to a location that is to hold the returned 55section-relative offset. 56If argument 57.Fa err 58is 59.No non- Ns Dv NULL , 60it is used to return an error descriptor in case of an error. 61.Sh RETURN VALUES 62On success, function 63.Fn dwarf_attroffset 64returns 65.Dv DW_DLV_OK . 66.Pp 67In case of an error, it returns 68.Dv DW_DLV_ERROR 69and sets argument 70.Fa err . 71.Sh COMPATIBILITY 72This function is an extension to the 73.Xr DWARF 3 74API. 75.Sh ERRORS 76The 77.Fn dwarf_attroffset 78function may fail with the following errors: 79.Bl -tag -width ".Bq Er DW_DLE_ARGUMENT" 80.It Bq Er DW_DLE_ARGUMENT 81Either of the arguments 82.Fa at 83or 84.Fa ret_off 85was 86.Dv NULL . 87.El 88.Sh SEE ALSO 89.Xr dwarf 3 , 90.Xr dwarf_attr 3 91