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