libdwarf/dwarf_get_address_size.3

   1 .\" Copyright (c) 2010 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_get_address_size.3 3644 2018-10-15 19:55:01Z jkoshy $
  26 .\"
  27 .Dd April 14, 2010
  28 .Dt DWARF_GET_ADDRESS_SIZE 3
  29 .Os
  30 .Sh NAME
  31 .Nm dwarf_get_address_size
  32 .Nd return the number of bytes needed to represent an address
  33 .Sh LIBRARY
  34 .Lb libdwarf
  35 .Sh SYNOPSIS
  36 .In libdwarf.h
  37 .Ft int
  38 .Fo dwarf_get_address_size
  39 .Fa "Dwarf_Debug dbg"
  40 .Fa "Dwarf_Half *addr_size"
  41 .Fa "Dwarf_Error *err"
  42 .Fc
  43 .Sh DESCRIPTION
  44 Function
  45 .Fn dwarf_get_address_size
  46 returns the size in bytes of a native address for a program object.
  47 .Pp
  48 Argument
  49 .Ar dbg
  50 should denote a DWARF debug context created from a program object using
  51 .Xr dwarf_init 3 .
  52 Argument
  53 .Ar addr_size
  54 should point to a location that will hold the returned size.
  55 Argument
  56 .Ar err ,
  57 if non-NULL, it will be used to return error information.
  58 .Sh RETURN VALUES
  59 On success, function
  60 .Fn dwarf_tag
  61 returns
  62 .Dv DW_DLV_OK .
  63 In case of an error, it returns
  64 .Dv DW_DLV_ERROR
  65 and sets argument
  66 .Ar err .
  67 .Sh ERRORS
  68 Function
  69 .Fn dwarf_get_address_size
  70 can fail with the following error:
  71 .Bl -tag -width ".Bq Er DW_DLE_ARGUMENT"
  72 .It Bq Er DW_DLE_ARGUMENT
  73 Either of arguments
  74 .Ar dbg
  75 or
  76 .Ar addr_size
  77 was NULL.
  78 .El
  79 .Sh SEE ALSO
  80 .Xr dwarf 3 ,
  81 .Xr dwarf_finish 3 ,
  82 .Xr dwarf_init 3