1.\" $NetBSD: dwarf_end_macro_file.3,v 1.2 2014/03/09 16:58:03 christos 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 2073 2011-10-27 03:30:47Z jkoshy 28.\" 29.Dd September 25, 2011 30.Os 31.Dt DWARF_END_MACRO_FILE 3 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.Fa 44.Fc 45.Sh DESCRIPTION 46Function 47.Fn dwarf_end_macro_file 48marks the end of the current source file inclusion. 49.Pp 50Argument 51.Ar dbg 52should reference a DWARF producer instance allocated using 53.Xr dwarf_producer_init 3 54or 55.Xr dwarf_producer_init_b 3 . 56.Pp 57If argument 58.Ar err 59is not NULL, it will be used to store error information in case of an 60error. 61.Sh RETURN VALUES 62On success, function 63.Fn dwarf_end_macro_file 64returns 65.Dv DW_DLV_OK . 66In case of an error, function 67.Fn dwarf_end_macro_file 68returns 69.Dv DW_DLV_ERROR 70and sets the argument 71.Ar err . 72.Sh ERRORS 73Function 74.Fn dwarf_end_macro_file 75can fail with: 76.Bl -tag -width ".Bq Er DW_DLE_ARGUMENT" 77.It Bq Er DW_DLE_ARGUMENT 78Argument 79.Ar dbg 80was NULL. 81.It Bq Er DW_DLE_MEMORY 82An out of memory condition was encountered during the execution of the 83function. 84.El 85.Sh SEE ALSO 86.Xr dwarf 3 , 87.Xr dwarf_def_macro 3 , 88.Xr dwarf_producer_init 3 , 89.Xr dwarf_producer_init_b 3 , 90.Xr dwarf_start_macro_file 3 , 91.Xr dwarf_undef_macro 3 , 92.Xr dwarf_vendor_ext 3 93