12de3b87aSKai Wang.\" Copyright (c) 2010 Joseph Koshy 22de3b87aSKai Wang.\" All rights reserved. 32de3b87aSKai Wang.\" 42de3b87aSKai Wang.\" Redistribution and use in source and binary forms, with or without 52de3b87aSKai Wang.\" modification, are permitted provided that the following conditions 62de3b87aSKai Wang.\" are met: 72de3b87aSKai Wang.\" 1. Redistributions of source code must retain the above copyright 82de3b87aSKai Wang.\" notice, this list of conditions and the following disclaimer. 92de3b87aSKai Wang.\" 2. Redistributions in binary form must reproduce the above copyright 102de3b87aSKai Wang.\" notice, this list of conditions and the following disclaimer in the 112de3b87aSKai Wang.\" documentation and/or other materials provided with the distribution. 122de3b87aSKai Wang.\" 132de3b87aSKai Wang.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 142de3b87aSKai Wang.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 152de3b87aSKai Wang.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 162de3b87aSKai Wang.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 172de3b87aSKai Wang.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 182de3b87aSKai Wang.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 192de3b87aSKai Wang.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 202de3b87aSKai Wang.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 212de3b87aSKai Wang.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 222de3b87aSKai Wang.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 232de3b87aSKai Wang.\" SUCH DAMAGE. 242de3b87aSKai Wang.\" 25*ae500c1fSEd Maste.\" $Id: dwarf_formstring.3 3640 2018-10-14 14:09:13Z jkoshy $ 262de3b87aSKai Wang.\" 272de3b87aSKai Wang.Dd July 24, 2010 282de3b87aSKai Wang.Dt DWARF_FORMSTRING 3 29*ae500c1fSEd Maste.Os 302de3b87aSKai Wang.Sh NAME 312de3b87aSKai Wang.Nm dwarf_formstring 322de3b87aSKai Wang.Nd return the value of a STRING class attribute 332de3b87aSKai Wang.Sh LIBRARY 342de3b87aSKai Wang.Lb libdwarf 352de3b87aSKai Wang.Sh SYNOPSIS 362de3b87aSKai Wang.In libdwarf.h 372de3b87aSKai Wang.Ft int 382de3b87aSKai Wang.Fo dwarf_formstring 392de3b87aSKai Wang.Fa "Dwarf_Attribute attr" 402de3b87aSKai Wang.Fa "char **ret" 412de3b87aSKai Wang.Fa "Dwarf_Error *err" 422de3b87aSKai Wang.Fc 432de3b87aSKai Wang.Sh DESCRIPTION 442de3b87aSKai WangFunction 452de3b87aSKai Wang.Fn dwarf_formstring 462de3b87aSKai Wangsets the location pointed to by argument 472de3b87aSKai Wang.Ar ret 482de3b87aSKai Wangto a pointer to a NUL-terminated string containing 492de3b87aSKai Wangthe value of the attribute referenced by argument 502de3b87aSKai Wang.Ar attr . 512de3b87aSKai WangThe form of argument 522de3b87aSKai Wang.Ar attr 532de3b87aSKai Wangmust be one of 542de3b87aSKai Wang.Dv DW_FORM_string 552de3b87aSKai Wangor 562de3b87aSKai Wang.Dv DW_FORM_strp . 572de3b87aSKai Wang.Pp 582de3b87aSKai WangIf argument 592de3b87aSKai Wang.Ar err 602de3b87aSKai Wangis not NULL, it will be used to return an error descriptor in case 612de3b87aSKai Wangof an error. 622de3b87aSKai Wang.Ss Memory Management 632de3b87aSKai WangThe memory area referenced by the returned pointer is managed by 642de3b87aSKai Wangthe DWARF(3) library. 652de3b87aSKai WangThe application should not attempt to directly free this memory 662de3b87aSKai Wangarea. 672de3b87aSKai Wang.Sh RETURN VALUES 682de3b87aSKai WangFunction 692de3b87aSKai Wang.Fn dwarf_formstring 702de3b87aSKai Wangreturns 712de3b87aSKai Wang.Dv DW_DLV_OK 722de3b87aSKai Wangon success. 732de3b87aSKai WangIn case of an error, it returns 742de3b87aSKai Wang.Dv DW_DLV_ERROR 752de3b87aSKai Wangand sets argument 762de3b87aSKai Wang.Ar err . 772de3b87aSKai Wang.Sh ERRORS 782de3b87aSKai WangFunction 792de3b87aSKai Wang.Fn dwarf_formstring 802de3b87aSKai Wangmay fail with the following errors: 812de3b87aSKai Wang.Bl -tag -width ".Bq Er DW_DLE_ATTR_FORM_BAD" 822de3b87aSKai Wang.It Bq Er DW_DLE_ARGUMENT 832de3b87aSKai WangEither of arguments 842de3b87aSKai Wang.Ar attr 852de3b87aSKai Wangor 862de3b87aSKai Wang.Ar ret 872de3b87aSKai Wangwas NULL. 882de3b87aSKai Wang.It Bq Er DW_DLE_ATTR_FORM_BAD 892de3b87aSKai WangThe attribute referenced by argument 902de3b87aSKai Wang.Ar attr 912de3b87aSKai Wangwas not of a permitted kind. 922de3b87aSKai Wang.El 932de3b87aSKai Wang.Sh SEE ALSO 942de3b87aSKai Wang.Xr dwarf 3 , 952de3b87aSKai Wang.Xr dwarf_attr 3 , 962de3b87aSKai Wang.Xr dwarf_formblock 3 , 972de3b87aSKai Wang.Xr dwarf_formref 3 , 982de3b87aSKai Wang.Xr dwarf_formsdata 3 , 992de3b87aSKai Wang.Xr dwarf_formsig8 3 , 1002de3b87aSKai Wang.Xr dwarf_formudata 3 , 1012de3b87aSKai Wang.Xr dwarf_hasattr 3 102