1.\" $NetBSD: dwarf_errmsg.3,v 1.2 2014/03/09 16:58:03 christos Exp $ 2.\" 3.\" Copyright (c) 2009 Joseph Koshy. All rights reserved. 4.\" 5.\" Redistribution and use in source and binary forms, with or without 6.\" modification, are permitted provided that the following conditions 7.\" are met: 8.\" 1. Redistributions of source code must retain the above copyright 9.\" notice, this list of conditions and the following disclaimer. 10.\" 2. Redistributions in binary form must reproduce the above copyright 11.\" notice, this list of conditions and the following disclaimer in the 12.\" documentation and/or other materials provided with the distribution. 13.\" 14.\" This software is provided by Joseph Koshy ``as is'' and 15.\" any express or implied warranties, including, but not limited to, the 16.\" implied warranties of merchantability and fitness for a particular purpose 17.\" are disclaimed. in no event shall Joseph Koshy be liable 18.\" for any direct, indirect, incidental, special, exemplary, or consequential 19.\" damages (including, but not limited to, procurement of substitute goods 20.\" or services; loss of use, data, or profits; or business interruption) 21.\" however caused and on any theory of liability, whether in contract, strict 22.\" liability, or tort (including negligence or otherwise) arising in any way 23.\" out of the use of this software, even if advised of the possibility of 24.\" such damage. 25.\" 26.\" Id: dwarf_errmsg.3 2073 2011-10-27 03:30:47Z jkoshy 27.\" 28.Dd December 12, 2009 29.Os 30.Dt DWARF_ERRMSG 3 31.Sh NAME 32.Nm dwarf_errmsg 33.Nd retrieve a human-readable string corresponding to a 34.Vt Dwarf_Error 35instance 36.Sh LIBRARY 37.Lb libdwarf 38.Sh SYNOPSIS 39.In libdwarf.h 40.Ft "const char *" 41.Fn dwarf_errmsg "Dwarf_Error err" 42.Sh DESCRIPTION 43Function 44.Fn dwarf_errmsg 45returns a 46.Dv NUL Ns - Ns 47terminated string for the error denoted by 48argument 49.Ar err . 50.Pp 51Argument 52.Ar err 53should be a valid handle to a 54.Vt Dwarf_Error 55instance. 56.Sh Memory Management 57The returned pointer should not be freed using 58.Xr free 3 59or 60.Xr dwarf_dealloc 3 . 61.Sh RETURN VALUES 62Function 63.Fn dwarf_errmsg 64returns a pointer to a 65.Dv NUL Ns - Ns 66terminated string. 67.Sh SEE ALSO 68.Xr dwarf 3 , 69.Xr dwarf_errno 3 70