1 .\" Copyright (c) 2011 Kai Wang
2 .\" All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
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.
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
25 .\" $Id: dwarf_get_str.3 2071 2011-10-27 03:20:00Z jkoshy $
32 .Nd retrieve a string from the DWARF string section
40 .Fa "Dwarf_Off offset"
42 .Fa "Dwarf_Signed *len"
43 .Fa "Dwarf_Error *err"
48 retrieves a NUL-terminated string from the DWARF string section
53 should reference a DWARF debug context allocated using
58 should be an offset, relative to the
60 section, specifying the start of the desired string.
64 should point to a location which will hold a returned
65 pointer to a NUL-terminated string.
69 should point to a location which will hold the length
70 of the returned string.
71 The returned length does not include the space needed for
76 is not NULL, it will be used to store error information in case of an
88 section associated with the specified debugging context,
89 or if the provided offset
94 In case of an error, it returns
102 .Bl -tag -width ".Bq Er DW_DLE_NO_ENTRY"
103 .It Bq Er DW_DLE_ARGUMENT
110 .It Bq Er DW_DLE_ARGUMENT
114 .It Bq Er DW_DLE_NO_ENTRY
115 The debugging context
120 .It Bq Er DW_DLE_NO_ENTRY
123 was at the very end of the
128 To retrieve all the strings in the DWARF string section, use:
129 .Bd -literal -offset indent
138 while ((ret = dwarf_get_str(dbg, offset, &str, &len, &de)) ==
140 /* .. Use the retrieved string. .. */
141 offset += len + 1; /* Account for the terminating NUL. */
144 if (ret == DW_DLV_ERROR)
145 warnx("dwarf_get_str: %s", dwarf_errmsg(de));