lib/libelf/elf_getshdrnum.3

   1 .\" Copyright (c) 2006,2008 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 August 4, 2009
  27 .Dt ELF_GETSHDRNUM 3
  28 .Os
  29 .Sh NAME
  30 .Nm elf_getshdrnum
  31 .Nd return the number of sections in an ELF file
  32 .Sh LIBRARY
  33 .Lb libelf
  34 .Sh SYNOPSIS
  35 .In libelf.h
  36 .Ft int
  37 .Fn elf_getshdrnum "Elf *elf" "size_t *shnum"
  38 .Sh DESCRIPTION
  39 Function
  40 .Fn elf_getshdrnum
  41 retrieves the number of ELF sections associated with descriptor
  42 .Ar elf
  43 and stores it into the location pointed to by argument
  44 .Ar shnum .
  45 .Pp
  46 This routine allows applications to uniformly process both normal ELF
  47 objects, and ELF objects that use extended section numbering.
  48 .Sh RETURN VALUES
  49 Function
  50 .Fn elf_getshdrnum
  51 returns zero value if successful, or -1 in case of an error.
  52 .Sh ERRORS
  53 Function
  54 .Fn elf_getshdrnum
  55 can fail with the following errors:
  56 .Bl -tag -width "[ELF_E_RESOURCE]"
  57 .It Bq Er ELF_E_ARGUMENT
  58 A NULL value was passed in for argument
  59 .Ar elf .
  60 .It Bq Er ELF_E_ARGUMENT
  61 Argument
  62 .Ar elf
  63 was not for an ELF file.
  64 .It Bq Er ELF_E_ARGUMENT
  65 Argument
  66 .Ar elf
  67 lacks an ELF Executable header.
  68 .El
  69 .Sh SEE ALSO
  70 .Xr elf 3 ,
  71 .Xr elf32_getehdr 3 ,
  72 .Xr elf64_getehdr 3 ,
  73 .Xr elf_getident 3 ,
  74 .Xr elf_getphdrnum 3 ,
  75 .Xr elf_getshdrstrndx 3 ,
  76 .Xr gelf 3 ,
  77 .Xr gelf_getehdr 3