1*0a6a1f1dSLionel Sambuc.\" $NetBSD: dwarf_formblock.3,v 1.2 2014/03/09 16:58:03 christos Exp $ 2*0a6a1f1dSLionel Sambuc.\" 3*0a6a1f1dSLionel Sambuc.\" Copyright (c) 2010 Joseph Koshy 4*0a6a1f1dSLionel Sambuc.\" All rights reserved. 5*0a6a1f1dSLionel Sambuc.\" 6*0a6a1f1dSLionel Sambuc.\" Redistribution and use in source and binary forms, with or without 7*0a6a1f1dSLionel Sambuc.\" modification, are permitted provided that the following conditions 8*0a6a1f1dSLionel Sambuc.\" are met: 9*0a6a1f1dSLionel Sambuc.\" 1. Redistributions of source code must retain the above copyright 10*0a6a1f1dSLionel Sambuc.\" notice, this list of conditions and the following disclaimer. 11*0a6a1f1dSLionel Sambuc.\" 2. Redistributions in binary form must reproduce the above copyright 12*0a6a1f1dSLionel Sambuc.\" notice, this list of conditions and the following disclaimer in the 13*0a6a1f1dSLionel Sambuc.\" documentation and/or other materials provided with the distribution. 14*0a6a1f1dSLionel Sambuc.\" 15*0a6a1f1dSLionel Sambuc.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 16*0a6a1f1dSLionel Sambuc.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 17*0a6a1f1dSLionel Sambuc.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 18*0a6a1f1dSLionel Sambuc.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 19*0a6a1f1dSLionel Sambuc.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 20*0a6a1f1dSLionel Sambuc.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 21*0a6a1f1dSLionel Sambuc.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 22*0a6a1f1dSLionel Sambuc.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 23*0a6a1f1dSLionel Sambuc.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 24*0a6a1f1dSLionel Sambuc.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 25*0a6a1f1dSLionel Sambuc.\" SUCH DAMAGE. 26*0a6a1f1dSLionel Sambuc.\" 27*0a6a1f1dSLionel Sambuc.\" Id: dwarf_formblock.3 2073 2011-10-27 03:30:47Z jkoshy 28*0a6a1f1dSLionel Sambuc.\" 29*0a6a1f1dSLionel Sambuc.Dd July 23, 2010 30*0a6a1f1dSLionel Sambuc.Os 31*0a6a1f1dSLionel Sambuc.Dt DWARF_FORMBLOCK 3 32*0a6a1f1dSLionel Sambuc.Sh NAME 33*0a6a1f1dSLionel Sambuc.Nm dwarf_formblock 34*0a6a1f1dSLionel Sambuc.Nd return the value of a BLOCK attribute 35*0a6a1f1dSLionel Sambuc.Sh LIBRARY 36*0a6a1f1dSLionel Sambuc.Lb libdwarf 37*0a6a1f1dSLionel Sambuc.Sh SYNOPSIS 38*0a6a1f1dSLionel Sambuc.In libdwarf.h 39*0a6a1f1dSLionel Sambuc.Ft int 40*0a6a1f1dSLionel Sambuc.Fo dwarf_formblock 41*0a6a1f1dSLionel Sambuc.Fa "Dwarf_Attribute attr" 42*0a6a1f1dSLionel Sambuc.Fa "Dwarf_Block **ret" 43*0a6a1f1dSLionel Sambuc.Fa "Dwarf_Error *err" 44*0a6a1f1dSLionel Sambuc.Fc 45*0a6a1f1dSLionel Sambuc.Sh DESCRIPTION 46*0a6a1f1dSLionel SambucFunction 47*0a6a1f1dSLionel Sambuc.Fn dwarf_formblock 48*0a6a1f1dSLionel Sambucsets the location pointed to by argument 49*0a6a1f1dSLionel Sambuc.Ar ret 50*0a6a1f1dSLionel Sambucto a pointer to a 51*0a6a1f1dSLionel Sambuc.Vt Dwarf_Block 52*0a6a1f1dSLionel Sambucstructure containing the value of the attribute referenced 53*0a6a1f1dSLionel Sambucby argument 54*0a6a1f1dSLionel Sambuc.Ar attr . 55*0a6a1f1dSLionel SambucThe form of argument 56*0a6a1f1dSLionel Sambuc.Ar attr 57*0a6a1f1dSLionel Sambucmust be one of 58*0a6a1f1dSLionel Sambuc.Dv DW_FORM_block , 59*0a6a1f1dSLionel Sambuc.Dv DW_FORM_block1 , 60*0a6a1f1dSLionel Sambuc.Dv DW_FORM_block2 61*0a6a1f1dSLionel Sambucor 62*0a6a1f1dSLionel Sambuc.Dv DW_FORM_block4 . 63*0a6a1f1dSLionel Sambuc.Pp 64*0a6a1f1dSLionel SambucIf argument 65*0a6a1f1dSLionel Sambuc.Ar err 66*0a6a1f1dSLionel Sambucis not NULL, it will be used to return an error descriptor in case 67*0a6a1f1dSLionel Sambucof an error. 68*0a6a1f1dSLionel Sambuc.Ss Memory Management 69*0a6a1f1dSLionel SambucThe memory area referenced by the returned pointer is managed by 70*0a6a1f1dSLionel Sambucthe DWARF(3) library. 71*0a6a1f1dSLionel SambucThe application should not attempt to free this memory 72*0a6a1f1dSLionel Sambucarea. 73*0a6a1f1dSLionel SambucPortable code may indicate that the memory area is to be freed by 74*0a6a1f1dSLionel Sambucby using 75*0a6a1f1dSLionel Sambuc.Xr dwarf_dealloc 3 . 76*0a6a1f1dSLionel Sambuc.Sh RETURN VALUES 77*0a6a1f1dSLionel SambucFunction 78*0a6a1f1dSLionel Sambuc.Fn dwarf_formblock 79*0a6a1f1dSLionel Sambucreturns 80*0a6a1f1dSLionel Sambuc.Dv DW_DLV_OK 81*0a6a1f1dSLionel Sambucon success. 82*0a6a1f1dSLionel SambucIn case of an error, it returns 83*0a6a1f1dSLionel Sambuc.Dv DW_DLV_ERROR 84*0a6a1f1dSLionel Sambucand sets argument 85*0a6a1f1dSLionel Sambuc.Ar err . 86*0a6a1f1dSLionel Sambuc.Sh ERRORS 87*0a6a1f1dSLionel SambucFunction 88*0a6a1f1dSLionel Sambuc.Fn dwarf_formblock 89*0a6a1f1dSLionel Sambucmay fail with the following errors: 90*0a6a1f1dSLionel Sambuc.Bl -tag -width ".Bq Er DW_DLE_ATTR_FORM_BAD" 91*0a6a1f1dSLionel Sambuc.It Bq Er DW_DLE_ARGUMENT 92*0a6a1f1dSLionel SambucEither of arguments 93*0a6a1f1dSLionel Sambuc.Ar attr 94*0a6a1f1dSLionel Sambucor 95*0a6a1f1dSLionel Sambuc.Ar ret 96*0a6a1f1dSLionel Sambucwas NULL. 97*0a6a1f1dSLionel Sambuc.It Bq Er DW_DLE_ATTR_FORM_BAD 98*0a6a1f1dSLionel SambucThe attribute referenced by argument 99*0a6a1f1dSLionel Sambuc.Ar attr 100*0a6a1f1dSLionel Sambucwas not of a permitted kind. 101*0a6a1f1dSLionel Sambuc.El 102*0a6a1f1dSLionel Sambuc.Sh SEE ALSO 103*0a6a1f1dSLionel Sambuc.Xr dwarf 3 , 104*0a6a1f1dSLionel Sambuc.Xr dwarf_attr 3 , 105*0a6a1f1dSLionel Sambuc.Xr dwarf_formflag 3 , 106*0a6a1f1dSLionel Sambuc.Xr dwarf_formref 3 , 107*0a6a1f1dSLionel Sambuc.Xr dwarf_formsdata 3 , 108*0a6a1f1dSLionel Sambuc.Xr dwarf_formsig8 3 , 109*0a6a1f1dSLionel Sambuc.Xr dwarf_formstring 3 , 110*0a6a1f1dSLionel Sambuc.Xr dwarf_formudata 3 , 111*0a6a1f1dSLionel Sambuc.Xr dwarf_hasattr 3 112