1.\" $NetBSD: dwarf_get_fde_n.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_fde_n.3 3962 2022-03-12 15:56:10Z jkoshy 28.\" 29.Dd May 14, 2011 30.Dt DWARF_GET_FDE_N 3 31.Os 32.Sh NAME 33.Nm dwarf_get_fde_n 34.Nd retrieve FDE descriptor 35.Sh LIBRARY 36.Lb libdwarf 37.Sh SYNOPSIS 38.In libdwarf.h 39.Ft int 40.Fo dwarf_get_fde_n 41.Fa "Dwarf_Fde *fdelist" 42.Fa "Dwarf_Unsigned fde_index" 43.Fa "Dwarf_Fde *ret_fde" 44.Fa "Dwarf_Error *err" 45.Fc 46.Sh DESCRIPTION 47Function 48.Fn dwarf_get_fde_n 49retrieves an FDE descriptor from an array of FDE descriptors. 50.Pp 51Argument 52.Fa fdelist 53should point to an array of FDE descriptors, as returned by the functions 54.Xr dwarf_get_fde_list 3 55or 56.Xr dwarf_get_fde_list_eh 3 . 57.Pp 58Argument 59.Fa fde_index 60specifies the 0-based index of the desired FDE descriptor. 61.Pp 62Argument 63.Fa ret_fde 64should point to a location that will hold the returned FDE descriptor. 65.Pp 66If argument 67.Fa err 68is not 69.Dv NULL , 70it will be used to store error information in case of an error. 71.Sh RETURN VALUES 72Function 73.Fn dwarf_get_fde_n 74returns 75.Dv DW_DLV_OK 76when it succeeds. 77It returns 78.Dv DW_DLV_NO_ENTRY 79if the FDE descriptor index specified by argument 80.Fa fde_index 81is out of range. 82In case of an error, it returns 83.Dv DW_DLV_ERROR 84and sets the argument 85.Fa err . 86.Sh ERRORS 87Function 88.Fn dwarf_get_fde_n 89can fail with: 90.Bl -tag -width ".Bq Er DW_DLE_NO_ENTRY" 91.It Bq Er DW_DLE_ARGUMENT 92Either of the arguments 93.Fa fdelist 94or 95.Fa ret_fde 96was 97.Dv NULL . 98.It Bq Er DW_DLE_NO_ENTRY 99The FDE descriptor index specified by argument 100.Fa fde_index 101was out of range. 102.El 103.Sh SEE ALSO 104.Xr dwarf 3 , 105.Xr dwarf_get_cie_of_fde 3 , 106.Xr dwarf_get_fde_at_pc 3 , 107.Xr dwarf_get_fde_info_for_all_regs 3 , 108.Xr dwarf_get_fde_info_for_all_regs3 3 , 109.Xr dwarf_get_fde_info_for_cfa_reg3 3 , 110.Xr dwarf_get_fde_info_for_reg 3 , 111.Xr dwarf_get_fde_info_for_reg3 3 , 112.Xr dwarf_get_fde_instr_bytes 3 , 113.Xr dwarf_get_fde_list 3 , 114.Xr dwarf_get_fde_list_eh 3 , 115.Xr dwarf_get_fde_range 3 116