1*0a6a1f1dSLionel Sambuc.\" $NetBSD: dwarf_end_macro_file.3,v 1.2 2014/03/09 16:58:03 christos Exp $ 2*0a6a1f1dSLionel Sambuc.\" 3*0a6a1f1dSLionel Sambuc.\" Copyright (c) 2011 Kai Wang 4*0a6a1f1dSLionel Sambuc.\" All rights reserved. 5*0a6a1f1dSLionel Sambuc.\" 6*0a6a1f1dSLionel Sambuc.\" Redistribution and use in source and binary forms, with or without 7*0a6a1f1dSLionel Sambuc.\" modification, are permitted provided that the following conditions 8*0a6a1f1dSLionel Sambuc.\" are met: 9*0a6a1f1dSLionel Sambuc.\" 1. Redistributions of source code must retain the above copyright 10*0a6a1f1dSLionel Sambuc.\" notice, this list of conditions and the following disclaimer. 11*0a6a1f1dSLionel Sambuc.\" 2. Redistributions in binary form must reproduce the above copyright 12*0a6a1f1dSLionel Sambuc.\" notice, this list of conditions and the following disclaimer in the 13*0a6a1f1dSLionel Sambuc.\" documentation and/or other materials provided with the distribution. 14*0a6a1f1dSLionel Sambuc.\" 15*0a6a1f1dSLionel Sambuc.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 16*0a6a1f1dSLionel Sambuc.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 17*0a6a1f1dSLionel Sambuc.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 18*0a6a1f1dSLionel Sambuc.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 19*0a6a1f1dSLionel Sambuc.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 20*0a6a1f1dSLionel Sambuc.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 21*0a6a1f1dSLionel Sambuc.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 22*0a6a1f1dSLionel Sambuc.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 23*0a6a1f1dSLionel Sambuc.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 24*0a6a1f1dSLionel Sambuc.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 25*0a6a1f1dSLionel Sambuc.\" SUCH DAMAGE. 26*0a6a1f1dSLionel Sambuc.\" 27*0a6a1f1dSLionel Sambuc.\" Id: dwarf_end_macro_file.3 2073 2011-10-27 03:30:47Z jkoshy 28*0a6a1f1dSLionel Sambuc.\" 29*0a6a1f1dSLionel Sambuc.Dd September 25, 2011 30*0a6a1f1dSLionel Sambuc.Os 31*0a6a1f1dSLionel Sambuc.Dt DWARF_END_MACRO_FILE 3 32*0a6a1f1dSLionel Sambuc.Sh NAME 33*0a6a1f1dSLionel Sambuc.Nm dwarf_end_macro_file 34*0a6a1f1dSLionel Sambuc.Nd mark the end of the current source file inclusion 35*0a6a1f1dSLionel Sambuc.Sh LIBRARY 36*0a6a1f1dSLionel Sambuc.Lb libdwarf 37*0a6a1f1dSLionel Sambuc.Sh SYNOPSIS 38*0a6a1f1dSLionel Sambuc.In libdwarf.h 39*0a6a1f1dSLionel Sambuc.Ft "int" 40*0a6a1f1dSLionel Sambuc.Fo dwarf_end_macro_file 41*0a6a1f1dSLionel Sambuc.Fa "Dwarf_P_Debug dbg" 42*0a6a1f1dSLionel Sambuc.Fa "Dwarf_Error *err" 43*0a6a1f1dSLionel Sambuc.Fa 44*0a6a1f1dSLionel Sambuc.Fc 45*0a6a1f1dSLionel Sambuc.Sh DESCRIPTION 46*0a6a1f1dSLionel SambucFunction 47*0a6a1f1dSLionel Sambuc.Fn dwarf_end_macro_file 48*0a6a1f1dSLionel Sambucmarks the end of the current source file inclusion. 49*0a6a1f1dSLionel Sambuc.Pp 50*0a6a1f1dSLionel SambucArgument 51*0a6a1f1dSLionel Sambuc.Ar dbg 52*0a6a1f1dSLionel Sambucshould reference a DWARF producer instance allocated using 53*0a6a1f1dSLionel Sambuc.Xr dwarf_producer_init 3 54*0a6a1f1dSLionel Sambucor 55*0a6a1f1dSLionel Sambuc.Xr dwarf_producer_init_b 3 . 56*0a6a1f1dSLionel Sambuc.Pp 57*0a6a1f1dSLionel SambucIf argument 58*0a6a1f1dSLionel Sambuc.Ar err 59*0a6a1f1dSLionel Sambucis not NULL, it will be used to store error information in case of an 60*0a6a1f1dSLionel Sambucerror. 61*0a6a1f1dSLionel Sambuc.Sh RETURN VALUES 62*0a6a1f1dSLionel SambucOn success, function 63*0a6a1f1dSLionel Sambuc.Fn dwarf_end_macro_file 64*0a6a1f1dSLionel Sambucreturns 65*0a6a1f1dSLionel Sambuc.Dv DW_DLV_OK . 66*0a6a1f1dSLionel SambucIn case of an error, function 67*0a6a1f1dSLionel Sambuc.Fn dwarf_end_macro_file 68*0a6a1f1dSLionel Sambucreturns 69*0a6a1f1dSLionel Sambuc.Dv DW_DLV_ERROR 70*0a6a1f1dSLionel Sambucand sets the argument 71*0a6a1f1dSLionel Sambuc.Ar err . 72*0a6a1f1dSLionel Sambuc.Sh ERRORS 73*0a6a1f1dSLionel SambucFunction 74*0a6a1f1dSLionel Sambuc.Fn dwarf_end_macro_file 75*0a6a1f1dSLionel Sambuccan fail with: 76*0a6a1f1dSLionel Sambuc.Bl -tag -width ".Bq Er DW_DLE_ARGUMENT" 77*0a6a1f1dSLionel Sambuc.It Bq Er DW_DLE_ARGUMENT 78*0a6a1f1dSLionel SambucArgument 79*0a6a1f1dSLionel Sambuc.Ar dbg 80*0a6a1f1dSLionel Sambucwas NULL. 81*0a6a1f1dSLionel Sambuc.It Bq Er DW_DLE_MEMORY 82*0a6a1f1dSLionel SambucAn out of memory condition was encountered during the execution of the 83*0a6a1f1dSLionel Sambucfunction. 84*0a6a1f1dSLionel Sambuc.El 85*0a6a1f1dSLionel Sambuc.Sh SEE ALSO 86*0a6a1f1dSLionel Sambuc.Xr dwarf 3 , 87*0a6a1f1dSLionel Sambuc.Xr dwarf_def_macro 3 , 88*0a6a1f1dSLionel Sambuc.Xr dwarf_producer_init 3 , 89*0a6a1f1dSLionel Sambuc.Xr dwarf_producer_init_b 3 , 90*0a6a1f1dSLionel Sambuc.Xr dwarf_start_macro_file 3 , 91*0a6a1f1dSLionel Sambuc.Xr dwarf_undef_macro 3 , 92*0a6a1f1dSLionel Sambuc.Xr dwarf_vendor_ext 3 93