1.\" $NetBSD: gelf_getshdr.3,v 1.6 2024/03/03 17:37:34 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 3958 2022-03-12 14:31:32Z jkoshy 27.\" 28.Dd August 27, 2006 29.Dt GELF_GETSHDR 3 30.Os 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.Fa scn . 51.Pp 52Function 53.Fn elf32_getshdr 54retrieves a pointer to an 55.Vt Elf32_Shdr 56structure. 57Section descriptor 58.Fa 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.Fa 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.Fa scn 76to the structure pointed to be argument 77.Fa 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 89.Dv NULL 90if an error was encountered. 91.Pp 92Function 93.Fn gelf_getshdr 94returns argument 95.Fa dst 96if successful, or 97.Dv NULL 98if an error was encountered. 99.Sh ERRORS 100These functions may fail with the following errors: 101.Bl -tag -width "[ELF_E_RESOURCE]" 102.It Bq Er ELF_E_ARGUMENT 103Arguments 104.Fa scn 105or 106.Fa shdr 107were 108.Dv NULL . 109.It Bq Er ELF_E_ARGUMENT 110Argument 111.Fa scn 112was not associated a descriptor for an ELF object. 113.It Bq Er ELF_E_CLASS 114The ELF class associated with the section descriptor 115.Fa scn 116did not match the class expected by the API. 117.El 118.Sh SEE ALSO 119.Xr elf 3 , 120.Xr elf_getscn 3 , 121.Xr gelf 3 , 122.Xr gelf_update_shdr 3 123