These functions retrieve and translate ELF program header information
from an ELF descriptor, if this information exists.
Functions
elf32_getphdr ();
and
elf64_getphdr ();
return a pointer to an array of translated
Vt Elf32_Phdr
and
Vt Elf64_Phdr
descriptors respectively.
These descriptors are described in
elf(5).
The number of entries in this array is specified by the
e_phnum
field of the executable header for ELF descriptor
elf
Function
gelf_getphdr ();
will retrieve the program header table entry at index
index
from ELF descriptor
elf.
The translated program header table entry will be written to the
address pointed to be argument
dst
Applications may inform the library of modifications to a program header table entry
by using the
elf_flagphdr3
API.
Applications using the
gelf(3)
interface need to use the
gelf_update_phdr3
API to copy modifications to a program header entry back to the underlying
ELF descriptor.
RETURN VALUES
The functions a valid pointer if successful, or NULL in case an error
was encountered.
ERRORS
These functions may fail with the following errors:
Bq Er ELF_E_ARGUMENT
Argument
elf
was NULL.
Bq Er ELF_E_ARGUMENT
Argument
elf
was not a descriptor for an ELF object.
Bq Er ELF_E_ARGUMENT
Argument
dst
was NULL.
Bq Er ELF_E_ARGUMENT
Index
index
was out of range.
Bq Er ELF_E_CLASS
The class of ELF descriptor
elf
did not match the expected class of the function being called.
Bq Er ELF_E_HEADER
ELF descriptor
elf
did not possess an executable header.
Bq Er ELF_E_HEADER
ELF descriptor
elf
had a corrupt executable header.
Bq Er ELF_E_RESOURCE
An out of memory condition was detected.
Bq Er ELF_E_SECTION
The ELF descriptor in argument
elf
did not adhere to the conventions used for extended numbering.
