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

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