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