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