1.\" $NetBSD: elf_getphdrnum.3,v 1.5 2022/03/12 21:37:55 jkoshy 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_getphdrnum.3 3956 2022-03-12 12:39:30Z jkoshy 27.\" 28.Dd July 25, 2018 29.Dt ELF_GETPHDRNUM 3 30.Os 31.Sh NAME 32.Nm elf_getphdrnum 33.Nd return the number of program headers in an ELF file 34.Sh LIBRARY 35.Lb libelf 36.Sh SYNOPSIS 37.In libelf.h 38.Ft int 39.Fn elf_getphdrnum "Elf *elf" "size_t *phnum" 40.Sh DESCRIPTION 41Function 42.Fn elf_getphdrnum 43retrieves the number of ELF program headers associated with descriptor 44.Fa elf 45and stores it into the location pointed to by argument 46.Fa phnum . 47.Pp 48This routine allows applications to uniformly process both normal ELF 49objects and ELF objects that use extended numbering. 50.Sh RETURN VALUES 51Function 52.Fn elf_getphdrnum 53returns a zero value if successful, or -1 in case of an error. 54.Sh ERRORS 55Function 56.Fn elf_getphdrnum 57can fail with the following errors: 58.Bl -tag -width "[ELF_E_RESOURCE]" 59.It Bq Er ELF_E_ARGUMENT 60A 61.Dv NULL 62value was passed in for argument 63.Fa elf . 64.It Bq Er ELF_E_ARGUMENT 65Argument 66.Fa elf 67was not for an ELF file. 68.It Bq Er ELF_E_ARGUMENT 69Argument 70.Fa elf 71lacks an ELF Executable Header. 72.It Bq Er ELF_E_HEADER 73The ELF Executable Header associated with argument 74.Fa elf 75was corrupt. 76.It Bq Er ELF_E_SECTION 77The section header at index 78.Dv SHN_UNDEF 79was corrupt. 80.El 81.Sh SEE ALSO 82.Xr elf 3 , 83.Xr elf32_getehdr 3 , 84.Xr elf64_getehdr 3 , 85.Xr elf_getident 3 , 86.Xr elf_getshdrnum 3 , 87.Xr elf_getshdrstrndx 3 , 88.Xr gelf 3 , 89.Xr gelf_getehdr 3 90