1*5ac3bc71Schristos.\" $NetBSD: dwarf_errmsg.3,v 1.6 2024/03/03 17:37:30 christos Exp $ 2e81373b4Schristos.\" 39dd9d0cfSchristos.\" Copyright (c) 2009 Joseph Koshy. All rights reserved. 49dd9d0cfSchristos.\" 59dd9d0cfSchristos.\" Redistribution and use in source and binary forms, with or without 69dd9d0cfSchristos.\" modification, are permitted provided that the following conditions 79dd9d0cfSchristos.\" are met: 89dd9d0cfSchristos.\" 1. Redistributions of source code must retain the above copyright 99dd9d0cfSchristos.\" notice, this list of conditions and the following disclaimer. 109dd9d0cfSchristos.\" 2. Redistributions in binary form must reproduce the above copyright 119dd9d0cfSchristos.\" notice, this list of conditions and the following disclaimer in the 129dd9d0cfSchristos.\" documentation and/or other materials provided with the distribution. 139dd9d0cfSchristos.\" 149dd9d0cfSchristos.\" This software is provided by Joseph Koshy ``as is'' and 159dd9d0cfSchristos.\" any express or implied warranties, including, but not limited to, the 169dd9d0cfSchristos.\" implied warranties of merchantability and fitness for a particular purpose 179dd9d0cfSchristos.\" are disclaimed. in no event shall Joseph Koshy be liable 189dd9d0cfSchristos.\" for any direct, indirect, incidental, special, exemplary, or consequential 199dd9d0cfSchristos.\" damages (including, but not limited to, procurement of substitute goods 209dd9d0cfSchristos.\" or services; loss of use, data, or profits; or business interruption) 219dd9d0cfSchristos.\" however caused and on any theory of liability, whether in contract, strict 229dd9d0cfSchristos.\" liability, or tort (including negligence or otherwise) arising in any way 239dd9d0cfSchristos.\" out of the use of this software, even if advised of the possibility of 249dd9d0cfSchristos.\" such damage. 259dd9d0cfSchristos.\" 26cdbf1fe1Sjkoshy.\" Id: dwarf_errmsg.3 3962 2022-03-12 15:56:10Z jkoshy 279dd9d0cfSchristos.\" 289dd9d0cfSchristos.Dd December 12, 2009 299dd9d0cfSchristos.Dt DWARF_ERRMSG 3 30604b0842Sjkoshy.Os 319dd9d0cfSchristos.Sh NAME 329dd9d0cfSchristos.Nm dwarf_errmsg 339dd9d0cfSchristos.Nd retrieve a human-readable string corresponding to a 349dd9d0cfSchristos.Vt Dwarf_Error 359dd9d0cfSchristosinstance 369dd9d0cfSchristos.Sh LIBRARY 379dd9d0cfSchristos.Lb libdwarf 389dd9d0cfSchristos.Sh SYNOPSIS 399dd9d0cfSchristos.In libdwarf.h 409dd9d0cfSchristos.Ft "const char *" 419dd9d0cfSchristos.Fn dwarf_errmsg "Dwarf_Error err" 429dd9d0cfSchristos.Sh DESCRIPTION 439dd9d0cfSchristosFunction 449dd9d0cfSchristos.Fn dwarf_errmsg 459dd9d0cfSchristosreturns a 469dd9d0cfSchristos.Dv NUL Ns - Ns 479dd9d0cfSchristosterminated string for the error denoted by 489dd9d0cfSchristosargument 49cdbf1fe1Sjkoshy.Fa err . 509dd9d0cfSchristos.Pp 519dd9d0cfSchristosArgument 52cdbf1fe1Sjkoshy.Fa err 539dd9d0cfSchristosshould be a valid handle to a 549dd9d0cfSchristos.Vt Dwarf_Error 559dd9d0cfSchristosinstance. 569dd9d0cfSchristos.Sh Memory Management 579dd9d0cfSchristosThe returned pointer should not be freed using 589dd9d0cfSchristos.Xr free 3 599dd9d0cfSchristosor 609dd9d0cfSchristos.Xr dwarf_dealloc 3 . 619dd9d0cfSchristos.Sh RETURN VALUES 629dd9d0cfSchristosFunction 639dd9d0cfSchristos.Fn dwarf_errmsg 649dd9d0cfSchristosreturns a pointer to a 659dd9d0cfSchristos.Dv NUL Ns - Ns 669dd9d0cfSchristosterminated string. 679dd9d0cfSchristos.Sh SEE ALSO 689dd9d0cfSchristos.Xr dwarf 3 , 699dd9d0cfSchristos.Xr dwarf_errno 3 70