xref: /freebsd/contrib/elftoolchain/libdwarf/dwarf_errmsg.3 (revision ae500c1ff8974130f7f2692772cf288b90349e0d)
12de3b87aSKai Wang.\" Copyright (c) 2009 Joseph Koshy.  All rights reserved.
22de3b87aSKai Wang.\"
32de3b87aSKai Wang.\" Redistribution and use in source and binary forms, with or without
42de3b87aSKai Wang.\" modification, are permitted provided that the following conditions
52de3b87aSKai Wang.\" are met:
62de3b87aSKai Wang.\" 1. Redistributions of source code must retain the above copyright
72de3b87aSKai Wang.\"    notice, this list of conditions and the following disclaimer.
82de3b87aSKai Wang.\" 2. Redistributions in binary form must reproduce the above copyright
92de3b87aSKai Wang.\"    notice, this list of conditions and the following disclaimer in the
102de3b87aSKai Wang.\"    documentation and/or other materials provided with the distribution.
112de3b87aSKai Wang.\"
122de3b87aSKai Wang.\" This software is provided by Joseph Koshy ``as is'' and
132de3b87aSKai Wang.\" any express or implied warranties, including, but not limited to, the
142de3b87aSKai Wang.\" implied warranties of merchantability and fitness for a particular purpose
152de3b87aSKai Wang.\" are disclaimed.  in no event shall Joseph Koshy be liable
162de3b87aSKai Wang.\" for any direct, indirect, incidental, special, exemplary, or consequential
172de3b87aSKai Wang.\" damages (including, but not limited to, procurement of substitute goods
182de3b87aSKai Wang.\" or services; loss of use, data, or profits; or business interruption)
192de3b87aSKai Wang.\" however caused and on any theory of liability, whether in contract, strict
202de3b87aSKai Wang.\" liability, or tort (including negligence or otherwise) arising in any way
212de3b87aSKai Wang.\" out of the use of this software, even if advised of the possibility of
222de3b87aSKai Wang.\" such damage.
232de3b87aSKai Wang.\"
24*ae500c1fSEd Maste.\" $Id: dwarf_errmsg.3 3640 2018-10-14 14:09:13Z jkoshy $
252de3b87aSKai Wang.\"
262de3b87aSKai Wang.Dd December 12, 2009
272de3b87aSKai Wang.Dt DWARF_ERRMSG 3
28*ae500c1fSEd Maste.Os
292de3b87aSKai Wang.Sh NAME
302de3b87aSKai Wang.Nm dwarf_errmsg
312de3b87aSKai Wang.Nd retrieve a human-readable string corresponding to a
322de3b87aSKai Wang.Vt Dwarf_Error
332de3b87aSKai Wanginstance
342de3b87aSKai Wang.Sh LIBRARY
352de3b87aSKai Wang.Lb libdwarf
362de3b87aSKai Wang.Sh SYNOPSIS
372de3b87aSKai Wang.In libdwarf.h
382de3b87aSKai Wang.Ft "const char *"
392de3b87aSKai Wang.Fn dwarf_errmsg "Dwarf_Error err"
402de3b87aSKai Wang.Sh DESCRIPTION
412de3b87aSKai WangFunction
422de3b87aSKai Wang.Fn dwarf_errmsg
432de3b87aSKai Wangreturns a
442de3b87aSKai Wang.Dv NUL Ns - Ns
452de3b87aSKai Wangterminated string for the error denoted by
462de3b87aSKai Wangargument
472de3b87aSKai Wang.Ar err .
482de3b87aSKai Wang.Pp
492de3b87aSKai WangArgument
502de3b87aSKai Wang.Ar err
512de3b87aSKai Wangshould be a valid handle to a
522de3b87aSKai Wang.Vt Dwarf_Error
532de3b87aSKai Wanginstance.
542de3b87aSKai Wang.Sh Memory Management
552de3b87aSKai WangThe returned pointer should not be freed using
562de3b87aSKai Wang.Xr free 3
572de3b87aSKai Wangor
582de3b87aSKai Wang.Xr dwarf_dealloc 3 .
592de3b87aSKai Wang.Sh RETURN VALUES
602de3b87aSKai WangFunction
612de3b87aSKai Wang.Fn dwarf_errmsg
622de3b87aSKai Wangreturns a pointer to a
632de3b87aSKai Wang.Dv NUL Ns - Ns
642de3b87aSKai Wangterminated string.
652de3b87aSKai Wang.Sh SEE ALSO
662de3b87aSKai Wang.Xr dwarf 3 ,
672de3b87aSKai Wang.Xr dwarf_errno 3
68