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