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