88 lines
2.6 KiB
Groff
88 lines
2.6 KiB
Groff
|
.\" Copyright (c) 2006 Joseph Koshy. All rights reserved.
|
||
|
|
.\"
|
||
|
|
.\" Redistribution and use in source and binary forms, with or without
|
||
|
|
.\" modification, are permitted provided that the following conditions
|
||
|
|
.\" are met:
|
||
|
|
.\" 1. Redistributions of source code must retain the above copyright
|
||
|
|
.\" notice, this list of conditions and the following disclaimer.
|
||
|
|
.\" 2. Redistributions in binary form must reproduce the above copyright
|
||
|
|
.\" notice, this list of conditions and the following disclaimer in the
|
||
|
|
.\" documentation and/or other materials provided with the distribution.
|
||
|
|
.\"
|
||
|
|
.\" This software is provided by Joseph Koshy ``as is'' and
|
||
|
|
.\" any express or implied warranties, including, but not limited to, the
|
||
|
|
.\" implied warranties of merchantability and fitness for a particular purpose
|
||
|
|
.\" are disclaimed. in no event shall Joseph Koshy be liable
|
||
|
|
.\" for any direct, indirect, incidental, special, exemplary, or consequential
|
||
|
|
.\" damages (including, but not limited to, procurement of substitute goods
|
||
|
|
.\" or services; loss of use, data, or profits; or business interruption)
|
||
|
|
.\" however caused and on any theory of liability, whether in contract, strict
|
||
|
|
.\" liability, or tort (including negligence or otherwise) arising in any way
|
||
|
|
.\" out of the use of this software, even if advised of the possibility of
|
||
|
|
.\" such damage.
|
||
|
|
.\"
|
||
|
|
.\" $FreeBSD$
|
||
|
|
.\"
|
||
|
|
.Dd December 16, 2006
|
||
|
|
.Os
|
||
|
|
.Dt ELF_GETPHNUM 3
|
||
|
|
.Sh NAME
|
||
|
|
.Nm elf_getphnum
|
||
|
|
.Nd return the number of program headers in an ELF file
|
||
|
|
.Sh LIBRARY
|
||
|
|
.Lb libelf
|
||
|
|
.Sh SYNOPSIS
|
||
|
|
.In libelf.h
|
||
|
|
.Ft int
|
||
|
|
.Fn elf_getphnum "Elf *elf" "size_t *phnum"
|
||
|
|
.Sh DESCRIPTION
|
||
|
|
Function
|
||
|
|
.Fn elf_getphnum
|
||
|
|
retrieves the number of ELF program headers associated with descriptor
|
||
|
|
.Ar elf
|
||
|
|
and stores it into the location pointed to by argument
|
||
|
|
.Ar phnum .
|
||
|
|
.Pp
|
||
|
|
This routine allows applications to uniformly process both normal ELF
|
||
|
|
objects and ELF objects that use extended numbering.
|
||
|
|
.Pp
|
||
|
|
.Sh RETURN VALUES
|
||
|
|
Function
|
||
|
|
.Fn elf_getphnum
|
||
|
|
returns a non-zero value if successful, or zero in case of an
|
||
|
|
error.
|
||
|
|
.Sh ERRORS
|
||
|
|
Function
|
||
|
|
.Fn elf_getphnum
|
||
|
|
can fail with the following errors:
|
||
|
|
.Bl -tag -width "[ELF_E_RESOURCE]"
|
||
|
|
.It Bq Er ELF_E_ARGUMENT
|
||
|
|
A NULL value was passed in for argument
|
||
|
|
.Ar elf .
|
||
|
|
.It Bq Er ELF_E_ARGUMENT
|
||
|
|
Argument
|
||
|
|
.Ar elf
|
||
|
|
was not for an ELF file.
|
||
|
|
.It Bq Er ELF_E_ARGUMENT
|
||
|
|
Argument
|
||
|
|
.Ar elf
|
||
|
|
lacks an ELF Executable Header.
|
||
|
|
.It Bq Er ELF_E_HEADER
|
||
|
|
The ELF Executable Header associated with argument
|
||
|
|
.Ar elf
|
||
|
|
was corrupt.
|
||
|
|
.It Bq Er ELF_E_SECTION
|
||
|
|
The section header at index
|
||
|
|
.Dv SHN_UNDEF
|
||
|
|
was corrupt.
|
||
|
|
.El
|
||
|
|
.Sh SEE ALSO
|
||
|
|
.Xr elf 3 ,
|
||
|
|
.Xr elf32_getehdr 3 ,
|
||
|
|
.Xr elf64_getehdr 3 ,
|
||
|
|
.Xr elf_getident 3 ,
|
||
|
|
.Xr elf_getshnum 3 ,
|
||
|
|
.Xr elf_getshstrndx 3 ,
|
||
|
|
.Xr gelf 3 ,
|
||
|
|
.Xr gelf_getehdr 3
|