xref: /freebsd/contrib/elftoolchain/libdwarf/dwarf_get_abbrev_code.3 (revision ae500c1ff8974130f7f2692772cf288b90349e0d)
1.\" Copyright (c) 2011 Kai Wang
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_get_abbrev_code.3 3644 2018-10-15 19:55:01Z jkoshy $
26.\"
27.Dd March 13, 2011
28.Dt DWARF_GET_ABBREV_CODE 3
29.Os
30.Sh NAME
31.Nm dwarf_get_abbrev_code
32.Nd retrieve the abbreviation code for an abbreviation
33.Sh LIBRARY
34.Lb libdwarf
35.Sh SYNOPSIS
36.In libdwarf.h
37.Ft int
38.Fo dwarf_get_abbrev_code
39.Fa "Dwarf_Abbrev abbrev"
40.Fa "Dwarf_Unsigned *ret"
41.Fa "Dwarf_Error *err"
42.Fc
43.Sh DESCRIPTION
44Function
45.Fn dwarf_get_abbrev_code
46retrieves the abbreviation code for the abbreviation entry descriptor
47referenced by argument
48.Ar abbrev .
49.Pp
50Argument
51.Ar ret
52should point to a location which will hold the returned
53abbreviation code.
54.Pp
55If argument
56.Ar err
57is not NULL, it will be used to store error information in case of an
58error.
59.Sh RETURN VALUES
60Function
61.Fn dwarf_get_abbrev_code
62returns
63.Dv DW_DLV_OK
64when it succeeds.
65In case of an error, it returns
66.Dv DW_DLV_ERROR
67and sets the argument
68.Ar err .
69.Sh ERRORS
70Function
71.Fn dwarf_get_abbrev_code
72can fail with:
73.Bl -tag -width ".Bq Er DW_DLE_ARGUMENT"
74.It Bq Er DW_DLE_ARGUMENT
75Either of arguments
76.Ar abbrev
77or
78.Ar ret
79was NULL.
80.El
81.Sh SEE ALSO
82.Xr dwarf 3 ,
83.Xr dwarf_get_abbrev 3 ,
84.Xr dwarf_get_abbrev_children_flag 3 ,
85.Xr dwarf_get_abbrev_entry 3 ,
86.Xr dwarf_get_abbrev_tag 3
87