external/bsd/libelf/dist/elf_getphnum.3

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