Copyright (c) 2010 Joseph Koshy
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_formexprloc.3 3640 2018-10-14 14:09:13Z jkoshy $

.Dd July 25, 2010 .Dt DWARF_FORMEXPRLOC 3 .Os .Sh NAME .Nm dwarf_formexprloc .Nd return information about a location expression .Sh LIBRARY .Lb libdwarf .Sh SYNOPSIS n libdwarf.h .Ft int .Fo dwarf_formexprloc .Fa "Dwarf_Attribute attr" .Fa "Dwarf_Unsigned *retlen" .Fa "Dwarf_Ptr *retexpr" .Fa "Dwarf_Error *err" .Fc .Sh DESCRIPTION Function .Fn dwarf_formexprloc allows an application to retrieve the length and the bytes of a DWARF location expression.

p Argument .Ar attr should reference a DWARF attribute of the form .Dv DW_FORM_exprloc . Argument .Ar retlen should point to a location that will be set to the length of the location expression. Argument .Ar retexpr should point to a location that will be set to a pointer to the content of the location expression itself.

p If argument .Ar err is not NULL, it will be used to return an error descriptor in case of an error. .Ss Memory Management The application should not attempt to free the memory area referenced by the pointer returned in argument .Ar retexpr . .Sh RETURN VALUES Function .Fn dwarf_formexprloc returns .Dv DW_DLV_OK on success. In case of an error, it returns .Dv DW_DLV_ERROR and sets argument .Ar err . .Sh ERRORS Function .Fn dwarf_formexprloc may fail with the following errors: l -tag -width ".Bq Er DW_DLE_ATTR_FORM_BAD" t Bq Er DW_DLE_ARGUMENT One of arguments .Ar attr , .Ar retlen or .Ar retexpr was NULL. t Bq Er DW_DLE_ATTR_FORM_BAD The attribute referenced by argument .Ar attr was not of form .Dv DW_FORM_exprloc . .El .Sh SEE ALSO .Xr dwarf 3 , .Xr dwarf_attr 3 , .Xr dwarf_formblock 3 , .Xr dwarf_formflag 3 , .Xr dwarf_formref 3 , .Xr dwarf_formsdata 3 , .Xr dwarf_formsig8 3 , .Xr dwarf_formstring 3 , .Xr dwarf_formudata 3 , .Xr dwarf_hasattr 3