All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:
1. Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
SUCH DAMAGE.
$Id: dwarf_add_die_to_debug.3 3640 2018-10-14 14:09:13Z jkoshy $
.Dd August 21, 2011 .Dt DWARF_ADD_DIE_TO_DEBUG 3 .Os .Sh NAME .Nm dwarf_add_die_to_debug .Nd set the root debugging information entry .Sh LIBRARY .Lb libdwarf .Sh SYNOPSIS n libdwarf.h .Ft Dwarf_Unsigned .Fo dwarf_add_die_to_debug .Fa "Dwarf_P_Debug dbg" .Fa "Dwarf_P_Die first_die" .Fa "Dwarf_Error *err" .Fc .Sh DESCRIPTION Function .Fn dwarf_add_die_to_debug sets the root debugging information entry of a DWARF producer instance. All debugging information entries linked to the root entry will also be added to the producer instance.
p Argument .Ar dbg should reference a DWARF producer instance allocated using .Xr dwarf_producer_init 3 or .Xr dwarf_producer_init_b 3 .
p Argument .Ar first_die should hold the debugging information entry which will become the root DIE.
p If argument .Ar err is not NULL, it will be used to store error information in case of an error. .Sh RETURN VALUES On success, function .Fn dwarf_add_die_to_debug returns .Dv DW_DLV_OK . In case of an error, function .Fn dwarf_add_die_to_debug returns .Dv DW_DLV_NOCOUNT and sets the argument .Ar err . .Sh ERRORS Function .Fn dwarf_add_die_to_debug can fail with: l -tag -width ".Bq Er DW_DLE_ARGUMENT" t Bq Er DW_DLE_ARGUMENT Either of the arguments .Ar dbg or .Ar first_die was NULL. .El .Sh SEE ALSO .Xr dwarf 3 , .Xr dwarf_die_link 3 , .Xr dwarf_new_die 3 , .Xr dwarf_producer_init 3 , .Xr dwarf_producer_init_b 3