1.\" Copyright (c) 2011 Kai Wang
2.\" All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\"    notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\"    notice, this list of conditions and the following disclaimer in the
11.\"    documentation and/or other materials provided with the distribution.
12.\"
13.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23.\" SUCH DAMAGE.
24.\"
25.\" $Id: dwarf_get_fde_n.3 2071 2011-10-27 03:20:00Z jkoshy $
26.\"
27.Dd May 14, 2011
28.Os
29.Dt DWARF_GET_FDE_N 3
30.Sh NAME
31.Nm dwarf_get_fde_n
32.Nd retrieve FDE descriptor
33.Sh LIBRARY
34.Lb libdwarf
35.Sh SYNOPSIS
36.In libdwarf.h
37.Ft int
38.Fo dwarf_get_fde_n
39.Fa "Dwarf_Fde *fdelist"
40.Fa "Dwarf_Unsigned fde_index"
41.Fa "Dwarf_Fde *ret_fde"
42.Fa "Dwarf_Error *err"
43.Fc
44.Sh DESCRIPTION
45Function
46.Fn dwarf_get_fde_n
47retrieves an FDE descriptor from an array of FDE descriptors.
48.Pp
49Argument
50.Ar fdelist
51should point to an array of FDE descriptors, as returned by the functions
52.Xr dwarf_get_fde_list 3
53or
54.Xr dwarf_get_fde_list_eh 3 .
55.Pp
56Argument
57.Ar fde_index
58specifies the 0-based index of the desired FDE descriptor.
59.Pp
60Argument
61.Ar ret_fde
62should point to a location that will hold the returned FDE descriptor.
63.Pp
64If argument
65.Ar err
66is not NULL, it will be used to store error information in case of an
67error.
68.Sh RETURN VALUES
69Function
70.Fn dwarf_get_fde_n
71returns
72.Dv DW_DLV_OK
73when it succeeds.
74It returns
75.Dv DW_DLV_NO_ENTRY
76if the FDE descriptor index specified by argument
77.Ar fde_index
78is out of range.
79In case of an error, it returns
80.Dv DW_DLV_ERROR
81and sets the argument
82.Ar err .
83.Sh ERRORS
84Function
85.Fn dwarf_get_fde_n
86can fail with:
87.Bl -tag -width ".Bq Er DW_DLE_NO_ENTRY"
88.It Bq Er DW_DLE_ARGUMENT
89Either of the arguments
90.Ar fdelist
91or
92.Ar ret_fde
93was NULL.
94.It Bq Er DW_DLE_NO_ENTRY
95The FDE descriptor index specified by argument
96.Ar fde_index
97was out of range.
98.El
99.Sh SEE ALSO
100.Xr dwarf 3 ,
101.Xr dwarf_get_cie_of_fde 3 ,
102.Xr dwarf_get_fde_at_pc 3 ,
103.Xr dwarf_get_fde_info_for_all_regs 3 ,
104.Xr dwarf_get_fde_info_for_all_regs3 3 ,
105.Xr dwarf_get_fde_info_for_cfa_reg3 3 ,
106.Xr dwarf_get_fde_info_for_reg 3 ,
107.Xr dwarf_get_fde_info_for_reg3 3 ,
108.Xr dwarf_get_fde_instr_bytes 3 ,
109.Xr dwarf_get_fde_list 3 ,
110.Xr dwarf_get_fde_list_eh 3 ,
111.Xr dwarf_get_fde_range 3
112