summaryrefslogtreecommitdiffstats
path: root/doc/elf32_getphdr.3
diff options
context:
space:
mode:
Diffstat (limited to 'doc/elf32_getphdr.3')
-rw-r--r--doc/elf32_getphdr.369
1 files changed, 69 insertions, 0 deletions
diff --git a/doc/elf32_getphdr.3 b/doc/elf32_getphdr.3
new file mode 100644
index 00000000..4b267b12
--- /dev/null
+++ b/doc/elf32_getphdr.3
@@ -0,0 +1,69 @@
+.TH ELF32_GETPHDR 3 "May 2024" "elfutils 0.186" "Library Functions Manual"
+.SH NAME
+elf32_getphdr \- retrieve the program header for a 32-bit ELF descriptor
+
+.SH SYNOPSIS
+.nf
+#include <libelf.h>
+
+Elf32_Phdr *elf32_getphdr(Elf *elf);
+.fi
+
+.SH DESCRIPTION
+.B elf32_getphdr
+retrieves the program header table for the given 32-bit ELF descriptor
+.I elf.
+The program header table contains information about the segments of the ELF file, which are used during the execution of the program.
+
+.SH PARAMETERS
+.TP
+.I elf
+Pointer to the ELF descriptor from which to retrieve the program header table.
+
+.SH RETURN VALUE
+On success,
+.B elf32_getphdr
+returns a pointer to the
+.B Elf32_Phdr
+structure. If the ELF descriptor is invalid or not a 32-bit ELF, it returns NULL and sets an error code retrievable by
+.BR elf_errno (3).
+
+.SH EXAMPLES
+.nf
+Elf *elf = elf_begin(fd, ELF_C_READ, NULL);
+if (elf == NULL) {
+ printf("Error: %s\n", elf_errmsg(-1));
+} else {
+ Elf32_Phdr *phdr = elf32_getphdr(elf);
+ if (phdr == NULL) {
+ printf("Error retrieving program header: %s\n", elf_errmsg(-1));
+ } else {
+ // Process the program header
+ for (int i = 0; i < ehdr->e_phnum; i++) {
+ printf("Program Header %d: Type: %d\n", i, phdr[i].p_type);
+ }
+ }
+ elf_end(elf);
+}
+.fi
+
+.SH SEE ALSO
+.BR elf_begin (3),
+.BR elf_end (3),
+.BR elf_errmsg (3),
+.BR elf_getphdrnum (3),
+.BR elf (5)
+
+.SH AUTHOR
+Written by the elfutils development team.
+
+.SH REPORTING BUGS
+Report bugs to <[email protected]>.
+
+.SH COPYRIGHT
+This is free software; see the source for copying conditions. There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+
+.SH HISTORY
+.B elf32_getphdr
+first appeared in elfutils 0.186.
+