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