external/bsd/elftoolchain/dist/libelf/elf_getphnum.3

   1 .\"     $NetBSD: elf_getphnum.3,v 1.2 2014/03/09 16:58:04 christos Exp $
   2 .\"
   3 .\" Copyright (c) 2006,2008 Joseph Koshy.  All rights reserved.
   4 .\"
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   8 .\" 1. Redistributions of source code must retain the above copyright
   9 .\"    notice, this list of conditions and the following disclaimer.
  10 .\" 2. Redistributions in binary form must reproduce the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer in the
  12 .\"    documentation and/or other materials provided with the distribution.
  13 .\"
  14 .\" This software is provided by Joseph Koshy ``as is'' and
  15 .\" any express or implied warranties, including, but not limited to, the
  16 .\" implied warranties of merchantability and fitness for a particular purpose
  17 .\" are disclaimed.  in no event shall Joseph Koshy be liable
  18 .\" for any direct, indirect, incidental, special, exemplary, or consequential
  19 .\" damages (including, but not limited to, procurement of substitute goods
  20 .\" or services; loss of use, data, or profits; or business interruption)
  21 .\" however caused and on any theory of liability, whether in contract, strict
  22 .\" liability, or tort (including negligence or otherwise) arising in any way
  23 .\" out of the use of this software, even if advised of the possibility of
  24 .\" such damage.
  25 .\"
  26 .\" Id: elf_getphnum.3 467 2009-08-05 18:18:49Z jkoshy
  27 .\"
  28 .Dd August 5, 2009
  29 .Os
  30 .Dt ELF_GETPHNUM 3
  31 .Sh NAME
  32 .Nm elf_getphnum
  33 .Nd return the number of program headers in an ELF file
  34 .Sh LIBRARY
  35 .Lb libelf
  36 .Sh SYNOPSIS
  37 .In libelf.h
  38 .Ft int
  39 .Fn elf_getphnum "Elf *elf" "size_t *phnum"
  40 .Sh DESCRIPTION
  41 This function is deprecated.
  42 Please use function
  43 .Xr elf_getphdrnum 3
  44 instead.
  45 .Pp
  46 Function
  47 .Fn elf_getphnum
  48 retrieves the number of ELF program headers associated with descriptor
  49 .Ar elf
  50 and stores it into the location pointed to by argument
  51 .Ar phnum .
  52 .Pp
  53 This routine allows applications to uniformly process both normal ELF
  54 objects and ELF objects that use extended numbering.
  55 .Pp
  56 .Sh RETURN VALUES
  57 Function
  58 .Fn elf_getphnum
  59 returns a non-zero value if successful, or zero in case of an
  60 error.
  61 .Sh ERRORS
  62 Function
  63 .Fn elf_getphnum
  64 can fail with the following errors:
  65 .Bl -tag -width "[ELF_E_RESOURCE]"
  66 .It Bq Er ELF_E_ARGUMENT
  67 A NULL value was passed in for argument
  68 .Ar elf .
  69 .It Bq Er ELF_E_ARGUMENT
  70 Argument
  71 .Ar elf
  72 was not for an ELF file.
  73 .It Bq Er ELF_E_ARGUMENT
  74 Argument
  75 .Ar elf
  76 lacks an ELF Executable Header.
  77 .It Bq Er ELF_E_HEADER
  78 The ELF Executable Header associated with argument
  79 .Ar elf
  80 was corrupt.
  81 .It Bq Er ELF_E_SECTION
  82 The section header at index
  83 .Dv SHN_UNDEF
  84 was corrupt.
  85 .El
  86 .Sh SEE ALSO
  87 .Xr elf 3 ,
  88 .Xr elf32_getehdr 3 ,
  89 .Xr elf64_getehdr 3 ,
  90 .Xr elf_getident 3 ,
  91 .Xr elf_getphdrnum 3 ,
  92 .Xr elf_getshdrnum 3 ,
  93 .Xr elf_getshdrstrndx 3 ,
  94 .Xr gelf 3 ,
  95 .Xr gelf_getehdr 3