source: rtems-tools/rtemstoolkit/elftoolchain/libelf/elf_getshstrndx.3 @ 0c5db2d

5
Last change on this file since 0c5db2d was 0c5db2d, checked in by Chris Johns <chrisj@…>, on 04/29/18 at 01:55:37

rtemstoolkit: Update elftoolchain to the latest code.

The update is taken from ​https://github.com/elftoolchain/elftoolchain.

Update #3417
  • Property mode set to 100644
File size: 2.8 KB
Line 
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$
25.\"
26.Dd August 5, 2009
27.Os
28.Dt ELF_GETSHSTRNDX 3
29.Sh NAME
30.Nm elf_getshstrndx ,
31.Nm elf_setshstrndx
32.Nd retrieve/update the index of the section name string table
33.Sh LIBRARY
34.Lb libelf
35.Sh SYNOPSIS
36.In libelf.h
37.Ft int
38.Fn elf_getshstrndx "Elf *elf" "size_t *ndxptr"
39.Ft int
40.Fn elf_setshstrndx "Elf *elf" "size_t ndx"
41.Sh DESCRIPTION
42Function
43.Fn elf_getshstrndx
44retrieves the section index of the string table containing section
45names from descriptor
46.Ar elf
47and stores it into the location pointed to by argument
48.Ar ndxptr .
49Function
50.Fn elf_getshstrndx
51is deprecated.
52Please use
53.Xr elf_getshdrstrndx 3
54instead.
55.Pp
56Function
57.Fn elf_setshstrndx
58sets the index of the section name string table to argument
59.Ar ndx .
60.Pp
61These routines allow applications to process both normal ELF
62objects and ELF objects that use extended section numbering uniformly.
63.Pp
64.Sh RETURN VALUES
65These functions return a non-zero value if successful, or zero in case
66of an error.
67.Sh ERRORS
68These functions can fail with the following errors:
69.Bl -tag -width "[ELF_E_RESOURCE]"
70.It Bq Er ELF_E_ARGUMENT
71A NULL value was passed in for argument
72.Ar elf .
73.It Bq Er ELF_E_ARGUMENT
74Argument
75.Ar elf
76was not for an ELF file.
77.It Bq Er ELF_E_ARGUMENT
78Argument
79.Ar elf
80lacks an ELF Executable header.
81.It Bq Er ELF_E_ARGUMENT
82Argument
83.Ar ndx
84contained a value in the reserved range of section indices.
85.El
86.Sh SEE ALSO
87.Xr elf 3 ,
88.Xr elf32_getehdr 3 ,
89.Xr elf64_getehdr 3 ,
90.Xr elf_getident 3 ,
91.Xr elf_getphdrnum 3 ,
92.Xr elf_getshdrnum 3 ,
93.Xr gelf 3 ,
94.Xr gelf_getehdr 3
Note: See TracBrowser for help on using the repository browser.