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_add_AT_string.3 2072 2011-10-27 03:26:49Z jkoshy $ 26.\" 27.Dd September 4, 2011 28.Os 29.Dt DWARF_ADD_AT_STRING 3 30.Sh NAME 31.Nm dwarf_add_AT_string 32.Nd create and attach a string class attribute 33.Sh LIBRARY 34.Lb libdwarf 35.Sh SYNOPSIS 36.In libdwarf.h 37.Ft Dwarf_P_Attribute 38.Fo dwarf_add_AT_string 39.Fa "Dwarf_P_Debug dbg" 40.Fa "Dwarf_P_Die die" 41.Fa "Dwarf_Half attr" 42.Fa "char *str" 43.Fa "Dwarf_Error *err" 44.Fc 45.Sh DESCRIPTION 46Function 47.Fn dwarf_add_AT_string 48creates an attribute descriptor belonging to the 49.Sq string 50class and attaches it to the debugging information entry referenced by 51argument 52.Ar die . 53The created attribute descriptor will have DWARF form 54.Dv DW_FORM_strp . 55.Pp 56Argument 57.Ar dbg 58should reference a DWARF producer instance allocated using 59.Xr dwarf_producer_init 3 60or 61.Xr dwarf_producer_init_b 3 . 62.Pp 63Argument 64.Ar die 65should reference a debugging information entry allocated using 66.Xr dwarf_new_die 3 . 67.Pp 68Argument 69.Ar attr 70should specify the attribute code for the created attribute 71descriptor. 72.Pp 73Argument 74.Ar str 75should hold a pointer to a NUL-terminated string which will become the 76value of the created attribute descriptor. 77.Pp 78If argument 79.Ar err 80is not NULL, it will be used to store error information in case of an 81error. 82.Sh RETURN VALUES 83On success, function 84.Fn dwarf_add_AT_string 85returns the created attribute descriptor. 86In case of an error, function 87.Fn dwarf_add_AT_string 88returns 89.Dv DW_DLV_BADADDR 90and sets the argument 91.Ar err . 92.Sh ERRORS 93Function 94.Fn dwarf_add_AT_string 95can fail with: 96.Bl -tag -width ".Bq Er DW_DLE_ARGUMENT" 97.It Bq Er DW_DLE_ARGUMENT 98One of the arguments 99.Ar dbg , 100.Ar die 101or 102.Ar str 103was NULL. 104.It Bq Er DW_DLE_MEMORY 105An out of memory condition was encountered during the execution of 106the function. 107.El 108.Sh SEE ALSO 109.Xr dwarf 3 , 110.Xr dwarf_add_AT_const_value_string 3 , 111.Xr dwarf_add_AT_name 3 , 112.Xr dwarf_new_die 3 , 113.Xr dwarf_producer_init 3 , 114.Xr dwarf_producer_init_b 3 115