87 lines
2.5 KiB
Groff
87 lines
2.5 KiB
Groff
.\" Copyright (c) 2011 Kai Wang
|
|
.\" All rights reserved.
|
|
.\"
|
|
.\" Redistribution and use in source and binary forms, with or without
|
|
.\" modification, are permitted provided that the following conditions
|
|
.\" are met:
|
|
.\" 1. Redistributions of source code must retain the above copyright
|
|
.\" notice, this list of conditions and the following disclaimer.
|
|
.\" 2. Redistributions in binary form must reproduce the above copyright
|
|
.\" notice, this list of conditions and the following disclaimer in the
|
|
.\" documentation and/or other materials provided with the distribution.
|
|
.\"
|
|
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
|
|
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
|
|
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
|
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
|
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
|
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
|
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
|
|
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
|
.\" SUCH DAMAGE.
|
|
.\"
|
|
.\" $Id: dwarf_get_cie_index.3 2071 2011-10-27 03:20:00Z jkoshy $
|
|
.\"
|
|
.Dd May 22, 2011
|
|
.Os
|
|
.Dt DWARF_GET_CIE_INDEX 3
|
|
.Sh NAME
|
|
.Nm dwarf_get_cie_index
|
|
.Nd retrieve the index of a CIE descriptor
|
|
.Sh LIBRARY
|
|
.Lb libdwarf
|
|
.Sh SYNOPSIS
|
|
.In libdwarf.h
|
|
.Ft int
|
|
.Fo dwarf_get_cie_index
|
|
.Fa "Dwarf_Cie cie"
|
|
.Fa "Dwarf_Signed *cie_index"
|
|
.Fa "Dwarf_Error *err"
|
|
.Fc
|
|
.Sh DESCRIPTION
|
|
Function
|
|
.Fn dwarf_get_cie_index
|
|
retrieves the zero-based index of a given CIE descriptor in the array
|
|
of CIE descriptors returned by the functions
|
|
.Xr dwarf_get_fde_list 3
|
|
and
|
|
.Xr dwarf_get_fde_list_eh 3 .
|
|
.Pp
|
|
Argument
|
|
.Ar cie
|
|
should reference a valid DWARF CIE descriptor.
|
|
.Pp
|
|
Argument
|
|
.Ar cie_index
|
|
should point to a location that will hold the returned index.
|
|
.Sh RETURN VALUES
|
|
Function
|
|
.Fn dwarf_get_cie_index
|
|
returns
|
|
.Dv DW_DLV_OK
|
|
when it succeeds.
|
|
In case of an error, it returns
|
|
.Dv DW_DLV_ERROR
|
|
and sets the argument
|
|
.Ar err .
|
|
.Sh ERRORS
|
|
Function
|
|
.Fn dwarf_get_cie_index
|
|
can fail with:
|
|
.Bl -tag -width ".Bq Er DW_DLE_ARGUMENT"
|
|
.It Bq Er DW_DLE_ARGUMENT
|
|
Either of arugments
|
|
.Ar cie
|
|
or
|
|
.Ar cie_index
|
|
was NULL.
|
|
.El
|
|
.Sh SEE ALSO
|
|
.Xr dwarf 3 ,
|
|
.Xr dwarf_get_cie_info 3 ,
|
|
.Xr dwarf_get_cie_of_fde 3 ,
|
|
.Xr dwarf_get_fde_list 3 ,
|
|
.Xr dwarf_get_fde_list_eh 3
|