1.\"	$NetBSD: elf_getshdrstrndx.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_getshdrstrndx.3 467 2009-08-05 18:18:49Z jkoshy
27.\"
28.Dd August 5, 2009
29.Os
30.Dt ELF_GETSHDRSTRNDX 3
31.Sh NAME
32.Nm elf_getshdrstrndx
33.Nd retrieve the index of the section name string table
34.Sh LIBRARY
35.Lb libelf
36.Sh SYNOPSIS
37.In libelf.h
38.Ft int
39.Fn elf_getshdrstrndx "Elf *elf" "size_t *ndxptr"
40.Sh DESCRIPTION
41Function
42.Fn elf_getshdrstrndx
43retrieves the section index of the string table containing section
44names from descriptor
45.Ar elf
46and stores it into the location pointed to by argument
47.Ar ndxptr .
48.Pp
49This function allow applications to process both normal ELF
50objects and ELF objects that use extended section numbering uniformly.
51.Pp
52.Sh RETURN VALUES
53These functions return zero if successful, or -1 in case of an error.
54.Sh ERRORS
55These functions can fail with the following errors:
56.Bl -tag -width "[ELF_E_RESOURCE]"
57.It Bq Er ELF_E_ARGUMENT
58A NULL value was passed in for argument
59.Ar elf .
60.It Bq Er ELF_E_ARGUMENT
61Argument
62.Ar elf
63was not for an ELF file.
64.It Bq Er ELF_E_ARGUMENT
65Argument
66.Ar elf
67lacks an ELF Executable header.
68.It Bq Er ELF_E_ARGUMENT
69Argument
70.Ar ndx
71contained a value in the reserved range of section indices.
72.El
73.Sh SEE ALSO
74.Xr elf 3 ,
75.Xr elf32_getehdr 3 ,
76.Xr elf64_getehdr 3 ,
77.Xr elf_getident 3 ,
78.Xr elf_getphdrnum 3 ,
79.Xr elf_getshdrnum 3 ,
80.Xr gelf 3 ,
81.Xr gelf_getehdr 3
82