xref: /freebsd/contrib/elftoolchain/libdwarf/dwarf_errno.3 (revision 031beb4e239bfce798af17f5fe8dba8bcaf13d99)
1.\" Copyright (c) 2009,2010 Joseph Koshy.  All rights reserved.
2.\"
3.\" Redistribution and use in source and binary forms, with or without
4.\" modification, are permitted provided that the following conditions
5.\" are met:
6.\" 1. Redistributions of source code must retain the above copyright
7.\"    notice, this list of conditions and the following disclaimer.
8.\" 2. Redistributions in binary form must reproduce the above copyright
9.\"    notice, this list of conditions and the following disclaimer in the
10.\"    documentation and/or other materials provided with the distribution.
11.\"
12.\" This software is provided by Joseph Koshy ``as is'' and
13.\" any express or implied warranties, including, but not limited to, the
14.\" implied warranties of merchantability and fitness for a particular purpose
15.\" are disclaimed.  in no event shall Joseph Koshy be liable
16.\" for any direct, indirect, incidental, special, exemplary, or consequential
17.\" damages (including, but not limited to, procurement of substitute goods
18.\" or services; loss of use, data, or profits; or business interruption)
19.\" however caused and on any theory of liability, whether in contract, strict
20.\" liability, or tort (including negligence or otherwise) arising in any way
21.\" out of the use of this software, even if advised of the possibility of
22.\" such damage.
23.\"
24.\" $Id: dwarf_errno.3 3640 2018-10-14 14:09:13Z jkoshy $
25.\"
26.Dd March 25, 2010
27.Dt DWARF_ERRNO 3
28.Os
29.Sh NAME
30.Nm dwarf_errno
31.Nd retrieve the error number corresponding to a
32.Vt Dwarf_Error
33instance
34.Sh LIBRARY
35.Lb libdwarf
36.Sh SYNOPSIS
37.In libdwarf.h
38.Ft int
39.Fn dwarf_errno "Dwarf_Error err"
40.Sh DESCRIPTION
41Function
42.Fn dwarf_errno
43returns the error number associated with a
44.Vt Dwarf_Error
45instance.
46.Pp
47Argument
48.Ar err
49should be a valid handle to a
50.Vt Dwarf_Error
51instance.
52.Sh RETURN VALUES
53Function
54.Fn dwarf_errno
55returns an integral value.
56.Sh SEE ALSO
57.Xr dwarf 3 ,
58.Xr dwarf_errmsg 3
59