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