1 | .\" Copyright (c) 2009 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_errmsg.3 2073 2011-10-27 03:30:47Z jkoshy $ |
---|
25 | .\" |
---|
26 | .Dd December 12, 2009 |
---|
27 | .Os |
---|
28 | .Dt DWARF_ERRMSG 3 |
---|
29 | .Sh NAME |
---|
30 | .Nm dwarf_errmsg |
---|
31 | .Nd retrieve a human-readable string corresponding to a |
---|
32 | .Vt Dwarf_Error |
---|
33 | instance |
---|
34 | .Sh LIBRARY |
---|
35 | .Lb libdwarf |
---|
36 | .Sh SYNOPSIS |
---|
37 | .In libdwarf.h |
---|
38 | .Ft "const char *" |
---|
39 | .Fn dwarf_errmsg "Dwarf_Error err" |
---|
40 | .Sh DESCRIPTION |
---|
41 | Function |
---|
42 | .Fn dwarf_errmsg |
---|
43 | returns a |
---|
44 | .Dv NUL Ns - Ns |
---|
45 | terminated string for the error denoted by |
---|
46 | argument |
---|
47 | .Ar err . |
---|
48 | .Pp |
---|
49 | Argument |
---|
50 | .Ar err |
---|
51 | should be a valid handle to a |
---|
52 | .Vt Dwarf_Error |
---|
53 | instance. |
---|
54 | .Sh Memory Management |
---|
55 | The returned pointer should not be freed using |
---|
56 | .Xr free 3 |
---|
57 | or |
---|
58 | .Xr dwarf_dealloc 3 . |
---|
59 | .Sh RETURN VALUES |
---|
60 | Function |
---|
61 | .Fn dwarf_errmsg |
---|
62 | returns a pointer to a |
---|
63 | .Dv NUL Ns - Ns |
---|
64 | terminated string. |
---|
65 | .Sh SEE ALSO |
---|
66 | .Xr dwarf 3 , |
---|
67 | .Xr dwarf_errno 3 |
---|