1.\" $NetBSD: dwarf_formstring.3,v 1.2 2014/03/09 16:58:03 christos Exp $ 2.\" 3.\" Copyright (c) 2010 Joseph Koshy 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_formstring.3 2073 2011-10-27 03:30:47Z jkoshy 28.\" 29.Dd July 24, 2010 30.Os 31.Dt DWARF_FORMSTRING 3 32.Sh NAME 33.Nm dwarf_formstring 34.Nd return the value of a STRING class attribute 35.Sh LIBRARY 36.Lb libdwarf 37.Sh SYNOPSIS 38.In libdwarf.h 39.Ft int 40.Fo dwarf_formstring 41.Fa "Dwarf_Attribute attr" 42.Fa "char **ret" 43.Fa "Dwarf_Error *err" 44.Fc 45.Sh DESCRIPTION 46Function 47.Fn dwarf_formstring 48sets the location pointed to by argument 49.Ar ret 50to a pointer to a NUL-terminated string containing 51the value of the attribute referenced by argument 52.Ar attr . 53The form of argument 54.Ar attr 55must be one of 56.Dv DW_FORM_string 57or 58.Dv DW_FORM_strp . 59.Pp 60If argument 61.Ar err 62is not NULL, it will be used to return an error descriptor in case 63of an error. 64.Ss Memory Management 65The memory area referenced by the returned pointer is managed by 66the DWARF(3) library. 67The application should not attempt to directly free this memory 68area. 69.Sh RETURN VALUES 70Function 71.Fn dwarf_formstring 72returns 73.Dv DW_DLV_OK 74on success. 75In case of an error, it returns 76.Dv DW_DLV_ERROR 77and sets argument 78.Ar err . 79.Sh ERRORS 80Function 81.Fn dwarf_formstring 82may fail with the following errors: 83.Bl -tag -width ".Bq Er DW_DLE_ATTR_FORM_BAD" 84.It Bq Er DW_DLE_ARGUMENT 85Either of arguments 86.Ar attr 87or 88.Ar ret 89was NULL. 90.It Bq Er DW_DLE_ATTR_FORM_BAD 91The attribute referenced by argument 92.Ar attr 93was not of a permitted kind. 94.El 95.Sh SEE ALSO 96.Xr dwarf 3 , 97.Xr dwarf_attr 3 , 98.Xr dwarf_formblock 3 , 99.Xr dwarf_formref 3 , 100.Xr dwarf_formsdata 3 , 101.Xr dwarf_formsig8 3 , 102.Xr dwarf_formudata 3 , 103.Xr dwarf_hasattr 3 104