1.\"	$NetBSD: gelf_getshdr.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: gelf_getshdr.3 189 2008-07-20 10:38:08Z jkoshy
27.\"
28.Dd August 27, 2006
29.Os
30.Dt GELF_GETSHDR 3
31.Sh NAME
32.Nm elf32_getshdr ,
33.Nm elf64_getshdr ,
34.Nm gelf_getshdr
35.Nd retrieve the class-dependent section header
36.Sh LIBRARY
37.Lb libelf
38.Sh SYNOPSIS
39.In libelf.h
40.Ft "Elf32_Shdr *"
41.Fn elf32_getshdr "Elf_Scn *scn"
42.Ft "Elf64_Shdr *"
43.Fn elf64_getshdr "Elf_Scn *scn"
44.In gelf.h
45.Ft "GElf_Shdr *"
46.Fn gelf_getshdr "Elf_Scn *scn" "GElf_Shdr *shdr"
47.Sh DESCRIPTION
48These functions return a pointer to the ELF Section Header data
49structure associated with section descriptor
50.Ar scn .
51.Pp
52Function
53.Fn elf32_getshdr
54retrieves a pointer to an
55.Vt Elf32_Shdr
56structure.
57Section descriptor
58.Ar scn
59must be associated with an ELF descriptor of class
60.Dv ELFCLASS32 .
61.Pp
62Function
63.Fn elf64_getshdr
64retrieves a pointer to an
65.Vt Elf64_Shdr
66structure.
67Section descriptor
68.Ar scn
69must be associated with an ELF descriptor of class
70.Dv ELFCLASS64 .
71.Pp
72Function
73.Fn gelf_getshdr
74copies the values in the section header associated with argument
75.Ar scn
76to the structure pointed to be argument
77.Ar dst .
78The
79.Vt GElf_Shdr
80data structure is described in
81.Xr gelf 3 .
82.Sh RETURN VALUES
83Functions
84.Fn elf32_getshdr
85and
86.Fn elf64_getshdr
87return a valid pointer to the appropriate section header on success
88or NULL if an error was encountered.
89.Pp
90Function
91.Fn gelf_getshdr
92returns argument
93.Ar dst
94if successful, or NULL if an error was encountered.
95.Sh ERRORS
96These functions may fail with the following errors:
97.Bl -tag -width "[ELF_E_RESOURCE]"
98.It Bq Er ELF_E_ARGUMENT
99Arguments
100.Ar scn
101or
102.Ar shdr
103were NULL.
104.It Bq Er ELF_E_ARGUMENT
105Argument
106.Ar scn
107was not associated a descriptor for an ELF object.
108.It Bq Er ELF_E_CLASS
109The ELF class associated with the section descriptor
110.Ar scn
111did not match the class expected by the API.
112.El
113.Sh SEE ALSO
114.Xr elf 3 ,
115.Xr elf_getscn 3 ,
116.Xr gelf 3 ,
117.Xr gelf_update_shdr 3
118