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