lib/libelf/elf_getphnum.3

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