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