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