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_get_abbrev_children_flag.3 2071 2011-10-27 03:20:00Z jkoshy $ 26.\" 27.Dd March 14, 2011 28.Os 29.Dt DWARF_GET_ABBREV_CHILDREN_FLAG 3 30.Sh NAME 31.Nm dwarf_get_abbrev_children_flag 32.Nd return a flag indicating the presence of children 33.Sh LIBRARY 34.Lb libdwarf 35.Sh SYNOPSIS 36.In libdwarf.h 37.Ft int 38.Fo dwarf_get_abbrev_children_flag 39.Fa "Dwarf_Abbrev abbrev" 40.Fa "Dwarf_Signed *ret" 41.Fa "Dwarf_Error *err" 42.Fc 43.Sh DESCRIPTION 44Function 45.Fn dwarf_get_abbrev_children_flag 46retrieves a flag indicating whether the DWARF debug information entry 47associated with a DWARF abbreviation descriptor has child entries. 48.Pp 49Argument 50.Ar abbrev 51should be a valid DWARF abbreviation descriptor, as returned by 52.Xr dwarf_get_abbrev 3 . 53.Pp 54Argument 55.Ar ret 56should point to a location which will hold the returned 57flag. 58The value returned will be one of the following: 59.Bl -tag -width ".Dv DW_CHILDREN_yes" -compact 60.It Dv DW_CHILDREN_yes 61The debugging information entry associated with the 62specified abbreviation descriptor has children. 63.It Dv DW_CHILDREN_no 64The debugging information entry associated with the 65specified abbreviation descriptor has no children. 66.El 67.Pp 68If argument 69.Ar err 70is not NULL, it will be used to store error information in case of an 71error. 72.Pp 73.Sh RETURN VALUES 74Function 75.Fn dwarf_get_abbrev_children_flag 76returns 77.Dv DW_DLV_OK 78when it succeeds. 79In case of an error, it returns 80.Dv DW_DLV_ERROR 81and sets the argument 82.Ar err . 83.Sh ERRORS 84Function 85.Fn dwarf_get_abbrev_children_flag 86can fail with: 87.Bl -tag -width ".Bq Er DW_DLE_ARGUMENT" 88.It Bq Er DW_DLE_ARGUMENT 89Either of arguments 90.Ar abbrev 91or 92.Ar ret 93was NULL. 94.El 95.Sh SEE ALSO 96.Xr dwarf 3 , 97.Xr dwarf_get_abbrev 3 , 98.Xr dwarf_get_abbrev_code 3 , 99.Xr dwarf_get_abbrev_tag 3 , 100.Xr dwarf_get_abbrev_entry 3 101