1.\" $NetBSD: dwarf_expr_current_offset.3,v 1.6 2024/03/03 17:37:30 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_expr_current_offset.3 3962 2022-03-12 15:56:10Z jkoshy 28.\" 29.Dd September 13, 2011 30.Dt DWARF_EXPR_CURRENT_OFFSET 3 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 45Function 46.Fn dwarf_expr_current_offset 47returns the size in bytes of the stream representation of a location 48expression. 49.Pp 50Argument 51.Fa expr 52should reference a location expression descriptor allocated using 53.Xr dwarf_new_expr 3 . 54.Pp 55If argument 56.Fa err 57is not 58.Dv NULL , 59it will be used to store error information in case of an error. 60.Sh RETURN VALUES 61On success, function 62.Fn dwarf_expr_current_offset 63returns the size in bytes of the location descriptor's stream 64representation. 65In case of an error, function 66.Fn dwarf_expr_current_offset 67returns 68.Dv DW_DLV_NOCOUNT 69and sets the argument 70.Fa err . 71.Sh ERRORS 72Function 73.Fn dwarf_expr_current_offset 74can fail with: 75.Bl -tag -width ".Bq Er DW_DLE_ARGUMENT" 76.It Bq Er DW_DLE_ARGUMENT 77Argument 78.Fa expr 79was 80.Dv NULL . 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 89