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