1*5ac3bc71Schristos.\" $NetBSD: dwarf_get_abbrev_code.3,v 1.6 2024/03/03 17:37:31 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_get_abbrev_code.3 3962 2022-03-12 15:56:10Z jkoshy 289dd9d0cfSchristos.\" 299dd9d0cfSchristos.Dd March 13, 2011 309dd9d0cfSchristos.Dt DWARF_GET_ABBREV_CODE 3 31604b0842Sjkoshy.Os 329dd9d0cfSchristos.Sh NAME 339dd9d0cfSchristos.Nm dwarf_get_abbrev_code 349dd9d0cfSchristos.Nd retrieve the abbreviation code for an abbreviation 359dd9d0cfSchristos.Sh LIBRARY 369dd9d0cfSchristos.Lb libdwarf 379dd9d0cfSchristos.Sh SYNOPSIS 389dd9d0cfSchristos.In libdwarf.h 399dd9d0cfSchristos.Ft int 409dd9d0cfSchristos.Fo dwarf_get_abbrev_code 419dd9d0cfSchristos.Fa "Dwarf_Abbrev abbrev" 429dd9d0cfSchristos.Fa "Dwarf_Unsigned *ret" 439dd9d0cfSchristos.Fa "Dwarf_Error *err" 449dd9d0cfSchristos.Fc 459dd9d0cfSchristos.Sh DESCRIPTION 469dd9d0cfSchristosFunction 479dd9d0cfSchristos.Fn dwarf_get_abbrev_code 489dd9d0cfSchristosretrieves the abbreviation code for the abbreviation entry descriptor 499dd9d0cfSchristosreferenced by argument 50cdbf1fe1Sjkoshy.Fa abbrev . 519dd9d0cfSchristos.Pp 529dd9d0cfSchristosArgument 53cdbf1fe1Sjkoshy.Fa ret 549dd9d0cfSchristosshould point to a location which will hold the returned 559dd9d0cfSchristosabbreviation code. 569dd9d0cfSchristos.Pp 579dd9d0cfSchristosIf argument 58cdbf1fe1Sjkoshy.Fa err 59cdbf1fe1Sjkoshyis not 60cdbf1fe1Sjkoshy.Dv NULL , 61cdbf1fe1Sjkoshyit will be used to store error information in case of an error. 629dd9d0cfSchristos.Sh RETURN VALUES 639dd9d0cfSchristosFunction 649dd9d0cfSchristos.Fn dwarf_get_abbrev_code 659dd9d0cfSchristosreturns 669dd9d0cfSchristos.Dv DW_DLV_OK 679dd9d0cfSchristoswhen it succeeds. 689dd9d0cfSchristosIn case of an error, it returns 699dd9d0cfSchristos.Dv DW_DLV_ERROR 709dd9d0cfSchristosand sets the argument 71cdbf1fe1Sjkoshy.Fa err . 729dd9d0cfSchristos.Sh ERRORS 739dd9d0cfSchristosFunction 749dd9d0cfSchristos.Fn dwarf_get_abbrev_code 759dd9d0cfSchristoscan fail with: 769dd9d0cfSchristos.Bl -tag -width ".Bq Er DW_DLE_ARGUMENT" 779dd9d0cfSchristos.It Bq Er DW_DLE_ARGUMENT 789dd9d0cfSchristosEither of arguments 79cdbf1fe1Sjkoshy.Fa abbrev 809dd9d0cfSchristosor 81cdbf1fe1Sjkoshy.Fa ret 82cdbf1fe1Sjkoshywas 83cdbf1fe1Sjkoshy.Dv NULL . 849dd9d0cfSchristos.El 859dd9d0cfSchristos.Sh SEE ALSO 869dd9d0cfSchristos.Xr dwarf 3 , 879dd9d0cfSchristos.Xr dwarf_get_abbrev 3 , 889dd9d0cfSchristos.Xr dwarf_get_abbrev_children_flag 3 , 89604b0842Sjkoshy.Xr dwarf_get_abbrev_entry 3 , 90604b0842Sjkoshy.Xr dwarf_get_abbrev_tag 3 91