.\" $NetBSD: gelf_getsyminfo.3,v 1.1.1.1 2009/12/19 05:43:40 thorpej Exp $ .\" .\" Copyright (c) 2006 Joseph Koshy. All rights reserved. .\" .\" Redistribution and use in source and binary forms, with or without .\" modification, are permitted provided that the following conditions .\" are met: .\" 1. Redistributions of source code must retain the above copyright .\" notice, this list of conditions and the following disclaimer. .\" 2. Redistributions in binary form must reproduce the above copyright .\" notice, this list of conditions and the following disclaimer in the .\" documentation and/or other materials provided with the distribution. .\" .\" This software is provided by Joseph Koshy ``as is'' and .\" any express or implied warranties, including, but not limited to, the .\" implied warranties of merchantability and fitness for a particular purpose .\" are disclaimed. in no event shall Joseph Koshy be liable .\" for any direct, indirect, incidental, special, exemplary, or consequential .\" damages (including, but not limited to, procurement of substitute goods .\" or services; loss of use, data, or profits; or business interruption) .\" however caused and on any theory of liability, whether in contract, strict .\" liability, or tort (including negligence or otherwise) arising in any way .\" out of the use of this software, even if advised of the possibility of .\" such damage. .\" .\" $FreeBSD: src/lib/libelf/gelf_getsyminfo.3,v 1.2.10.1.2.1 2009/10/25 01:10:29 kensmith Exp $ .\" .Dd August 29, 2006 .Os .Dt GELF_GETSYMINFO 3 .Sh NAME .Nm gelf_getsyminfo , .Nm gelf_update_syminfo .Nd read and update symbol information .Sh LIBRARY .Lb libelf .Sh SYNOPSIS .In gelf.h .Ft "GElf_Syminfo *" .Fn gelf_getsyminfo "Elf_Data *data" "int ndx" "GElf_Syminfo *syminfo" .Ft int .Fn gelf_update_syminfo "Elf_Data *data" "int ndx" "GElf_Syminfo *syminfo" .Sh DESCRIPTION These convenience functions are used to retrieve and update class-dependent .Vt Elf32_Syminfo and .Vt Elf64_Syminfo records in an ELF object. .Pp Argument .Ar data is an .Vt Elf_Data descriptor associated with a section of type .Dv SHT_SUNW_syminfo . Argument .Ar ndx is the index of the record being retrieved or updated. The class-independent .Vt GElf_Syminfo structure is described in .Xr gelf 3 . .Pp Function .Fn gelf_getsyminfo retrieves class-dependent record at index .Ar ndx in data buffer .Ar data and copies it to the destination pointed to by argument .Ar syminfo after translation to class-independent form. .Pp Function .Fn gelf_update_syminfo converts the class-independent record pointed to by argument .Ar syminfo to class-dependent form, and writes it to the record at index .Ar ndx in the data buffer described by argument .Ar data . .Sh RETURN VALUES Function .Fn gelf_getsyminfo returns the value of argument .Ar syminfo if successful, or NULL in case of an error. Function .Fn gelf_update_syminfo returns a non-zero value if successful, or zero in case of an error. .Sh ERRORS These functions may fail with the following errors: .Bl -tag -width "[ELF_E_RESOURCE]" .It Bq Er ELF_E_ARGUMENT Arguments .Ar data or .Ar syminfo were NULL. .It Bq Er ELF_E_ARGUMENT Argument .Ar ndx was less than zero or larger than the number of symbols in the data descriptor. .It Bq Er ELF_E_ARGUMENT Data descriptor .Ar data was not associated with a section containing symbol information. .El .Sh SEE ALSO .Xr elf 3 , .Xr elf_getdata 3 , .Xr elf_getscn 3 , .Xr gelf 3 , .Xr gelf_getsym 3 , .Xr gelf_update_sym 3