1.\" $NetBSD: dwarf_get_abbrev_code.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_code.3 3962 2022-03-12 15:56:10Z jkoshy 28.\" 29.Dd March 13, 2011 30.Dt DWARF_GET_ABBREV_CODE 3 31.Os 32.Sh NAME 33.Nm dwarf_get_abbrev_code 34.Nd retrieve the abbreviation code for an abbreviation 35.Sh LIBRARY 36.Lb libdwarf 37.Sh SYNOPSIS 38.In libdwarf.h 39.Ft int 40.Fo dwarf_get_abbrev_code 41.Fa "Dwarf_Abbrev abbrev" 42.Fa "Dwarf_Unsigned *ret" 43.Fa "Dwarf_Error *err" 44.Fc 45.Sh DESCRIPTION 46Function 47.Fn dwarf_get_abbrev_code 48retrieves the abbreviation code for the abbreviation entry descriptor 49referenced by argument 50.Fa abbrev . 51.Pp 52Argument 53.Fa ret 54should point to a location which will hold the returned 55abbreviation code. 56.Pp 57If argument 58.Fa err 59is not 60.Dv NULL , 61it will be used to store error information in case of an error. 62.Sh RETURN VALUES 63Function 64.Fn dwarf_get_abbrev_code 65returns 66.Dv DW_DLV_OK 67when it succeeds. 68In case of an error, it returns 69.Dv DW_DLV_ERROR 70and sets the argument 71.Fa err . 72.Sh ERRORS 73Function 74.Fn dwarf_get_abbrev_code 75can fail with: 76.Bl -tag -width ".Bq Er DW_DLE_ARGUMENT" 77.It Bq Er DW_DLE_ARGUMENT 78Either of arguments 79.Fa abbrev 80or 81.Fa ret 82was 83.Dv NULL . 84.El 85.Sh SEE ALSO 86.Xr dwarf 3 , 87.Xr dwarf_get_abbrev 3 , 88.Xr dwarf_get_abbrev_children_flag 3 , 89.Xr dwarf_get_abbrev_entry 3 , 90.Xr dwarf_get_abbrev_tag 3 91