xref: /freebsd/contrib/elftoolchain/libdwarf/dwarf_find_macro_value_start.3 (revision 8ddb146abcdf061be9f2c0db7e391697dafad85c)
1.\" Copyright (c) 2011 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_find_macro_value_start.3 3640 2018-10-14 14:09:13Z jkoshy $
26.\"
27.Dd March 26, 2011
28.Dt DWARF_FIND_MACRO_VALUE_START 3
29.Os
30.Sh NAME
31.Nm dwarf_find_macro_value_start
32.Nd return the address of the first byte of a macro value
33.Sh LIBRARY
34.Lb libdwarf
35.Sh SYNOPSIS
36.In libdwarf.h
37.Ft char *
38.Fo dwarf_find_macro_value_start
39.Fa "char *macro_string"
40.Fc
41.Sh DESCRIPTION
42Given a DWARF macro string, function
43.Fn dwarf_find_macro_value_start
44returns a pointer to the first byte of the macro value part of the
45macro string.
46.Pp
47Argument
48.Ar macro_string
49should be a NUL-terminated string conforming to the macro format
50defined in the DWARF standard; see
51.Xr dwarf 4 .
52.Sh RETURN VALUES
53On success, function
54.Fn dwarf_find_macro_value_start
55returns a pointer to the first byte of the macro value.
56If the macro value part was not found, function
57.Fn dwarf_find_macro_value_start
58returns a pointer to the NUL-byte terminating argument
59.Ar macro_string .
60.Pp
61Function
62.Fn dwarf_find_macro_value_start
63returns NULL if argument
64.Ar macro_string
65was NULL.
66.Sh SEE ALSO
67.Xr dwarf 3 ,
68.Xr dwarf_get_macro_details 3
69