1*5ac3bc71Schristos.\" $NetBSD: dwarf_end_macro_file.3,v 1.6 2024/03/03 17:37:30 christos Exp $ 2e81373b4Schristos.\" 39dd9d0cfSchristos.\" Copyright (c) 2011 Kai Wang 49dd9d0cfSchristos.\" All rights reserved. 59dd9d0cfSchristos.\" 69dd9d0cfSchristos.\" Redistribution and use in source and binary forms, with or without 79dd9d0cfSchristos.\" modification, are permitted provided that the following conditions 89dd9d0cfSchristos.\" are met: 99dd9d0cfSchristos.\" 1. Redistributions of source code must retain the above copyright 109dd9d0cfSchristos.\" notice, this list of conditions and the following disclaimer. 119dd9d0cfSchristos.\" 2. Redistributions in binary form must reproduce the above copyright 129dd9d0cfSchristos.\" notice, this list of conditions and the following disclaimer in the 139dd9d0cfSchristos.\" documentation and/or other materials provided with the distribution. 149dd9d0cfSchristos.\" 159dd9d0cfSchristos.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 169dd9d0cfSchristos.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 179dd9d0cfSchristos.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 189dd9d0cfSchristos.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 199dd9d0cfSchristos.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 209dd9d0cfSchristos.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 219dd9d0cfSchristos.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 229dd9d0cfSchristos.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 239dd9d0cfSchristos.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 249dd9d0cfSchristos.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 259dd9d0cfSchristos.\" SUCH DAMAGE. 269dd9d0cfSchristos.\" 27cdbf1fe1Sjkoshy.\" Id: dwarf_end_macro_file.3 3962 2022-03-12 15:56:10Z jkoshy 289dd9d0cfSchristos.\" 299dd9d0cfSchristos.Dd September 25, 2011 309dd9d0cfSchristos.Dt DWARF_END_MACRO_FILE 3 31604b0842Sjkoshy.Os 329dd9d0cfSchristos.Sh NAME 339dd9d0cfSchristos.Nm dwarf_end_macro_file 349dd9d0cfSchristos.Nd mark the end of the current source file inclusion 359dd9d0cfSchristos.Sh LIBRARY 369dd9d0cfSchristos.Lb libdwarf 379dd9d0cfSchristos.Sh SYNOPSIS 389dd9d0cfSchristos.In libdwarf.h 399dd9d0cfSchristos.Ft "int" 409dd9d0cfSchristos.Fo dwarf_end_macro_file 419dd9d0cfSchristos.Fa "Dwarf_P_Debug dbg" 429dd9d0cfSchristos.Fa "Dwarf_Error *err" 439dd9d0cfSchristos.Fc 449dd9d0cfSchristos.Sh DESCRIPTION 459dd9d0cfSchristosFunction 469dd9d0cfSchristos.Fn dwarf_end_macro_file 479dd9d0cfSchristosmarks the end of the current source file inclusion. 489dd9d0cfSchristos.Pp 499dd9d0cfSchristosArgument 50cdbf1fe1Sjkoshy.Fa dbg 519dd9d0cfSchristosshould reference a DWARF producer instance allocated using 529dd9d0cfSchristos.Xr dwarf_producer_init 3 539dd9d0cfSchristosor 549dd9d0cfSchristos.Xr dwarf_producer_init_b 3 . 559dd9d0cfSchristos.Pp 569dd9d0cfSchristosIf argument 57cdbf1fe1Sjkoshy.Fa err 58cdbf1fe1Sjkoshyis not 59cdbf1fe1Sjkoshy.Dv NULL , 60cdbf1fe1Sjkoshyit will be used to store error information in case of an error. 619dd9d0cfSchristos.Sh RETURN VALUES 629dd9d0cfSchristosOn success, function 639dd9d0cfSchristos.Fn dwarf_end_macro_file 649dd9d0cfSchristosreturns 659dd9d0cfSchristos.Dv DW_DLV_OK . 669dd9d0cfSchristosIn case of an error, function 679dd9d0cfSchristos.Fn dwarf_end_macro_file 689dd9d0cfSchristosreturns 699dd9d0cfSchristos.Dv DW_DLV_ERROR 709dd9d0cfSchristosand sets the argument 71cdbf1fe1Sjkoshy.Fa err . 729dd9d0cfSchristos.Sh ERRORS 739dd9d0cfSchristosFunction 749dd9d0cfSchristos.Fn dwarf_end_macro_file 759dd9d0cfSchristoscan fail with: 769dd9d0cfSchristos.Bl -tag -width ".Bq Er DW_DLE_ARGUMENT" 779dd9d0cfSchristos.It Bq Er DW_DLE_ARGUMENT 789dd9d0cfSchristosArgument 79cdbf1fe1Sjkoshy.Fa dbg 80cdbf1fe1Sjkoshywas 81cdbf1fe1Sjkoshy.Dv NULL . 829dd9d0cfSchristos.It Bq Er DW_DLE_MEMORY 839dd9d0cfSchristosAn out of memory condition was encountered during the execution of the 849dd9d0cfSchristosfunction. 859dd9d0cfSchristos.El 869dd9d0cfSchristos.Sh SEE ALSO 879dd9d0cfSchristos.Xr dwarf 3 , 889dd9d0cfSchristos.Xr dwarf_def_macro 3 , 899dd9d0cfSchristos.Xr dwarf_producer_init 3 , 909dd9d0cfSchristos.Xr dwarf_producer_init_b 3 , 919dd9d0cfSchristos.Xr dwarf_start_macro_file 3 , 929dd9d0cfSchristos.Xr dwarf_undef_macro 3 , 939dd9d0cfSchristos.Xr dwarf_vendor_ext 3 94