xref: /minix3/external/bsd/elftoolchain/dist/libdwarf/dwarf_whatattr.3 (revision 0a6a1f1d05b60e214de2f05a7310ddd1f0e590e7)
1.\"	$NetBSD: dwarf_whatattr.3,v 1.2 2014/03/09 16:58:04 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 2075 2011-10-27 03:47:28Z jkoshy
28.\"
29.Dd May 22, 2010
30.Os
31.Dt DWARF_WHATATTR 3
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.Ar attr ,
51and writes it to the location pointed to by argument
52.Ar retcode .
53If argument
54.Ar err
55is not NULL, it will be used to return an error descriptor in case
56of an error.
57.Sh RETURN VALUES
58On success, function
59.Fn dwarf_whatattr
60returns
61.Dv DW_DLV_OK .
62In case of an error, it returns
63.Dv DW_DLV_ERROR
64and sets argument
65.Ar err .
66.Sh ERRORS
67Function
68.Fn dwarf_whatattr
69can fail with the following error:
70.Bl -tag -width ".Bq Er DW_DLE_ARGUMENT"
71.It Bq Er DW_DLE_ARGUMENT
72Either of argument
73.Va attr
74or
75.Va retcode
76was NULL.
77.Sh SEE ALSO
78.Xr dwarf 3 ,
79.Xr dwarf_attr 3 ,
80.Xr dwarf_hasattr 3
81