1.\" $NetBSD: dwarf_get_cie_index.3,v 1.2 2014/03/09 16:58:04 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_cie_index.3 2071 2011-10-27 03:20:00Z jkoshy 28.\" 29.Dd May 22, 2011 30.Os 31.Dt DWARF_GET_CIE_INDEX 3 32.Sh NAME 33.Nm dwarf_get_cie_index 34.Nd retrieve the index of a CIE descriptor 35.Sh LIBRARY 36.Lb libdwarf 37.Sh SYNOPSIS 38.In libdwarf.h 39.Ft int 40.Fo dwarf_get_cie_index 41.Fa "Dwarf_Cie cie" 42.Fa "Dwarf_Signed *cie_index" 43.Fa "Dwarf_Error *err" 44.Fc 45.Sh DESCRIPTION 46Function 47.Fn dwarf_get_cie_index 48retrieves the zero-based index of a given CIE descriptor in the array 49of CIE descriptors returned by the functions 50.Xr dwarf_get_fde_list 3 51and 52.Xr dwarf_get_fde_list_eh 3 . 53.Pp 54Argument 55.Ar cie 56should reference a valid DWARF CIE descriptor. 57.Pp 58Argument 59.Ar cie_index 60should point to a location that will hold the returned index. 61.Sh RETURN VALUES 62Function 63.Fn dwarf_get_cie_index 64returns 65.Dv DW_DLV_OK 66when it succeeds. 67In case of an error, it returns 68.Dv DW_DLV_ERROR 69and sets the argument 70.Ar err . 71.Sh ERRORS 72Function 73.Fn dwarf_get_cie_index 74can fail with: 75.Bl -tag -width ".Bq Er DW_DLE_ARGUMENT" 76.It Bq Er DW_DLE_ARGUMENT 77Either of arugments 78.Ar cie 79or 80.Ar cie_index 81was NULL. 82.El 83.Sh SEE ALSO 84.Xr dwarf 3 , 85.Xr dwarf_get_cie_info 3 , 86.Xr dwarf_get_cie_of_fde 3 , 87.Xr dwarf_get_fde_list 3 , 88.Xr dwarf_get_fde_list_eh 3 89