1.\"	$NetBSD: elf_getshstrndx.3,v 1.2 2014/03/09 16:58:04 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 467 2009-08-05 18:18:49Z jkoshy
27.\"
28.Dd August 5, 2009
29.Os
30.Dt ELF_GETSHSTRNDX 3
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
46retrieves the section index of the string table containing section
47names from descriptor
48.Ar elf
49and stores it into the location pointed to by argument
50.Ar ndxptr .
51Function
52.Fn elf_getshstrndx
53is deprecated.
54Please use
55.Xr elf_getshdrstrndx 3
56instead.
57.Pp
58Function
59.Fn elf_setshstrndx
60sets the index of the section name string table to argument
61.Ar ndx .
62.Pp
63These routines allow applications to process both normal ELF
64objects and ELF objects that use extended section numbering uniformly.
65.Pp
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 NULL value was passed in for argument
74.Ar elf .
75.It Bq Er ELF_E_ARGUMENT
76Argument
77.Ar elf
78was not for an ELF file.
79.It Bq Er ELF_E_ARGUMENT
80Argument
81.Ar elf
82lacks an ELF Executable header.
83.It Bq Er ELF_E_ARGUMENT
84Argument
85.Ar ndx
86contained a value in the reserved range of section indices.
87.El
88.Sh SEE ALSO
89.Xr elf 3 ,
90.Xr elf32_getehdr 3 ,
91.Xr elf64_getehdr 3 ,
92.Xr elf_getident 3 ,
93.Xr elf_getphdrnum 3 ,
94.Xr elf_getshdrnum 3 ,
95.Xr gelf 3 ,
96.Xr gelf_getehdr 3
97