external/bsd/elftoolchain/dist/libdwarf/dwarf_formblock.3

   1 .\"     $NetBSD: dwarf_formblock.3,v 1.2 2014/03/09 16:58:03 christos Exp $
   2 .\"
   3 .\" Copyright (c) 2010 Joseph Koshy
   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_formblock.3 2073 2011-10-27 03:30:47Z jkoshy
  28 .\"
  29 .Dd July 23, 2010
  30 .Os
  31 .Dt DWARF_FORMBLOCK 3
  32 .Sh NAME
  33 .Nm dwarf_formblock
  34 .Nd return the value of a BLOCK attribute
  35 .Sh LIBRARY
  36 .Lb libdwarf
  37 .Sh SYNOPSIS
  38 .In libdwarf.h
  39 .Ft int
  40 .Fo dwarf_formblock
  41 .Fa "Dwarf_Attribute attr"
  42 .Fa "Dwarf_Block **ret"
  43 .Fa "Dwarf_Error *err"
  44 .Fc
  45 .Sh DESCRIPTION
  46 Function
  47 .Fn dwarf_formblock
  48 sets the location pointed to by argument
  49 .Ar ret
  50 to a pointer to a
  51 .Vt Dwarf_Block
  52 structure containing the value of the attribute referenced
  53 by argument
  54 .Ar attr .
  55 The form of argument
  56 .Ar attr
  57 must be one of
  58 .Dv DW_FORM_block ,
  59 .Dv DW_FORM_block1 ,
  60 .Dv DW_FORM_block2
  61 or
  62 .Dv DW_FORM_block4 .
  63 .Pp
  64 If argument
  65 .Ar err
  66 is not NULL, it will be used to return an error descriptor in case
  67 of an error.
  68 .Ss Memory Management
  69 The memory area referenced by the returned pointer is managed by
  70 the DWARF(3) library.
  71 The application should not attempt to free this memory
  72 area.
  73 Portable code may indicate that the memory area is to be freed by
  74 by using
  75 .Xr dwarf_dealloc 3 .
  76 .Sh RETURN VALUES
  77 Function
  78 .Fn dwarf_formblock
  79 returns
  80 .Dv DW_DLV_OK
  81 on success.
  82 In case of an error, it returns
  83 .Dv DW_DLV_ERROR
  84 and sets argument
  85 .Ar err .
  86 .Sh ERRORS
  87 Function
  88 .Fn dwarf_formblock
  89 may fail with the following errors:
  90 .Bl -tag -width ".Bq Er DW_DLE_ATTR_FORM_BAD"
  91 .It Bq Er DW_DLE_ARGUMENT
  92 Either of arguments
  93 .Ar attr
  94 or
  95 .Ar ret
  96 was NULL.
  97 .It Bq Er DW_DLE_ATTR_FORM_BAD
  98 The attribute referenced by argument
  99 .Ar attr
 100 was not of a permitted kind.
 101 .El
 102 .Sh SEE ALSO
 103 .Xr dwarf 3 ,
 104 .Xr dwarf_attr 3 ,
 105 .Xr dwarf_formflag 3 ,
 106 .Xr dwarf_formref 3 ,
 107 .Xr dwarf_formsdata 3 ,
 108 .Xr dwarf_formsig8 3 ,
 109 .Xr dwarf_formstring 3 ,
 110 .Xr dwarf_formudata 3 ,
 111 .Xr dwarf_hasattr 3