1.\" $NetBSD: dwarf_whatattr.3,v 1.6 2024/03/03 17:37:32 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_whatattr.3 3963 2022-03-12 16:07:32Z jkoshy 28.\" 29.Dd May 22, 2010 30.Dt DWARF_WHATATTR 3 31.Os 32.Sh NAME 33.Nm dwarf_whatattr 34.Nd retrieve the attribute code for a DWARF attribute 35.Sh LIBRARY 36.Lb libdwarf 37.Sh SYNOPSIS 38.In libdwarf.h 39.Ft int 40.Fo dwarf_whatattr 41.Fa "Dwarf_Attribute attr" 42.Fa "Dwarf_Half *retcode" 43.Fa "Dwarf_Error *err" 44.Fc 45.Sh DESCRIPTION 46Function 47.Fn dwarf_whatattr 48retrieves the attribute code for the DWARF attribute referenced 49by argument 50.Fa attr , 51and writes it to the location pointed to by argument 52.Fa retcode . 53If argument 54.Fa err 55is not 56.Dv NULL , 57it will be used to return an error descriptor in case of an error. 58.Sh RETURN VALUES 59On success, function 60.Fn dwarf_whatattr 61returns 62.Dv DW_DLV_OK . 63In case of an error, it returns 64.Dv DW_DLV_ERROR 65and sets argument 66.Fa err . 67.Sh ERRORS 68Function 69.Fn dwarf_whatattr 70can fail with the following error: 71.Bl -tag -width ".Bq Er DW_DLE_ARGUMENT" 72.It Bq Er DW_DLE_ARGUMENT 73Either of argument 74.Va attr 75or 76.Va retcode 77was 78.Dv NULL . 79.El 80.Sh SEE ALSO 81.Xr dwarf 3 , 82.Xr dwarf_attr 3 , 83.Xr dwarf_hasattr 3 84