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