1.\" Copyright (c) 2006,2008 Joseph Koshy. All rights reserved. 2.\" 3.\" Redistribution and use in source and binary forms, with or without 4.\" modification, are permitted provided that the following conditions 5.\" are met: 6.\" 1. Redistributions of source code must retain the above copyright 7.\" notice, this list of conditions and the following disclaimer. 8.\" 2. Redistributions in binary form must reproduce the above copyright 9.\" notice, this list of conditions and the following disclaimer in the 10.\" documentation and/or other materials provided with the distribution. 11.\" 12.\" This software is provided by Joseph Koshy ``as is'' and 13.\" any express or implied warranties, including, but not limited to, the 14.\" implied warranties of merchantability and fitness for a particular purpose 15.\" are disclaimed. in no event shall Joseph Koshy be liable 16.\" for any direct, indirect, incidental, special, exemplary, or consequential 17.\" damages (including, but not limited to, procurement of substitute goods 18.\" or services; loss of use, data, or profits; or business interruption) 19.\" however caused and on any theory of liability, whether in contract, strict 20.\" liability, or tort (including negligence or otherwise) arising in any way 21.\" out of the use of this software, even if advised of the possibility of 22.\" such damage. 23.\" 24.\" $Id: elf_getshdrstrndx.3 467 2009-08-05 18:18:49Z jkoshy $ 25.\" 26.Dd August 5, 2009 27.Os 28.Dt ELF_GETSHDRSTRNDX 3 29.Sh NAME 30.Nm elf_getshdrstrndx 31.Nd retrieve the index of the section name string table 32.Sh LIBRARY 33.Lb libelf 34.Sh SYNOPSIS 35.In libelf.h 36.Ft int 37.Fn elf_getshdrstrndx "Elf *elf" "size_t *ndxptr" 38.Sh DESCRIPTION 39Function 40.Fn elf_getshdrstrndx 41retrieves the section index of the string table containing section 42names from descriptor 43.Ar elf 44and stores it into the location pointed to by argument 45.Ar ndxptr . 46.Pp 47This function allow applications to process both normal ELF 48objects and ELF objects that use extended section numbering uniformly. 49.Pp 50.Sh RETURN VALUES 51These functions return zero if successful, or -1 in case of an error. 52.Sh ERRORS 53These functions can fail with the following errors: 54.Bl -tag -width "[ELF_E_RESOURCE]" 55.It Bq Er ELF_E_ARGUMENT 56A NULL value was passed in for argument 57.Ar elf . 58.It Bq Er ELF_E_ARGUMENT 59Argument 60.Ar elf 61was not for an ELF file. 62.It Bq Er ELF_E_ARGUMENT 63Argument 64.Ar elf 65lacks an ELF Executable header. 66.It Bq Er ELF_E_ARGUMENT 67Argument 68.Ar ndx 69contained a value in the reserved range of section indices. 70.El 71.Sh SEE ALSO 72.Xr elf 3 , 73.Xr elf32_getehdr 3 , 74.Xr elf64_getehdr 3 , 75.Xr elf_getident 3 , 76.Xr elf_getphdrnum 3 , 77.Xr elf_getshdrnum 3 , 78.Xr gelf 3 , 79.Xr gelf_getehdr 3 80