Return to dwarf_expr_current_offset.3 CVS log

Up to [cvs.NetBSD.org] / src / external / bsd / elftoolchain / dist / libdwarf

Annotation of src/external/bsd/elftoolchain/dist/libdwarf/dwarf_expr_current_offset.3, Revision 1.5

1.2       christos    1: .\"    $NetBSD$
                      2: .\"
1.1       christos    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: .\"
1.5     ! jkoshy     27: .\" Id: dwarf_expr_current_offset.3 3962 2022-03-12 15:56:10Z jkoshy
1.1       christos   28: .\"
                     29: .Dd September 13, 2011
1.4       jkoshy     30: .Dt DWARF_EXPR_CURRENT_OFFSET 3
1.1       christos   31: .Os
                     32: .Sh NAME
                     33: .Nm dwarf_expr_current_offset
                     34: .Nd retrieve the number of bytes in a location expression stream
                     35: .Sh LIBRARY
                     36: .Lb libdwarf
                     37: .Sh SYNOPSIS
                     38: .In libdwarf.h
                     39: .Ft "Dwarf_Unsigned"
                     40: .Fo dwarf_expr_current_offset
                     41: .Fa "Dwarf_P_Expr expr"
                     42: .Fa "Dwarf_Error *err"
                     43: .Fc
                     44: .Sh DESCRIPTION
                     45: Function
                     46: .Fn dwarf_expr_current_offset
                     47: returns the size in bytes of the stream representation of a location
                     48: expression.
                     49: .Pp
                     50: Argument
1.5     ! jkoshy     51: .Fa expr
1.1       christos   52: should reference a location expression descriptor allocated using
                     53: .Xr dwarf_new_expr 3 .
                     54: .Pp
                     55: If argument
1.5     ! jkoshy     56: .Fa err
        !            57: is not
        !            58: .Dv NULL ,
        !            59: it will be used to store error information in case of an error.
1.1       christos   60: .Sh RETURN VALUES
                     61: On success, function
                     62: .Fn dwarf_expr_current_offset
                     63: returns the size in bytes of the location descriptor's stream
                     64: representation.
                     65: In case of an error, function
                     66: .Fn dwarf_expr_current_offset
                     67: returns
                     68: .Dv DW_DLV_NOCOUNT
                     69: and sets the argument
1.5     ! jkoshy     70: .Fa err .
1.1       christos   71: .Sh ERRORS
                     72: Function
                     73: .Fn dwarf_expr_current_offset
                     74: can fail with:
                     75: .Bl -tag -width ".Bq Er DW_DLE_ARGUMENT"
                     76: .It Bq Er DW_DLE_ARGUMENT
                     77: Argument
1.5     ! jkoshy     78: .Fa expr
        !            79: was
        !            80: .Dv NULL .
1.1       christos   81: .El
                     82: .Sh SEE ALSO
                     83: .Xr dwarf 3 ,
                     84: .Xr dwarf_add_expr_addr 3 ,
                     85: .Xr dwarf_add_expr_addr_b 3 ,
                     86: .Xr dwarf_add_expr_gen 3 ,
                     87: .Xr dwarf_expr_into_block 3 ,
                     88: .Xr dwarf_new_expr 3