.\"	$NetBSD: elf_getshdrnum.3,v 1.5 2022/03/12 21:37:55 jkoshy Exp $
.\"
.\" Copyright (c) 2006,2008 Joseph Koshy.  All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\"
.\" This software is provided by Joseph Koshy ``as is'' and
.\" any express or implied warranties, including, but not limited to, the
.\" implied warranties of merchantability and fitness for a particular purpose
.\" are disclaimed.  in no event shall Joseph Koshy be liable
.\" for any direct, indirect, incidental, special, exemplary, or consequential
.\" damages (including, but not limited to, procurement of substitute goods
.\" or services; loss of use, data, or profits; or business interruption)
.\" however caused and on any theory of liability, whether in contract, strict
.\" liability, or tort (including negligence or otherwise) arising in any way
.\" out of the use of this software, even if advised of the possibility of
.\" such damage.
.\"
.\" Id: elf_getshdrnum.3 3956 2022-03-12 12:39:30Z jkoshy
.\"
.Dd August 4, 2009
.Dt ELF_GETSHDRNUM 3
.Os
.Sh NAME
.Nm elf_getshdrnum
.Nd return the number of sections in an ELF file
.Sh LIBRARY
.Lb libelf
.Sh SYNOPSIS
.In libelf.h
.Ft int
.Fn elf_getshdrnum "Elf *elf" "size_t *shnum"
.Sh DESCRIPTION
Function
.Fn elf_getshdrnum
retrieves the number of ELF sections associated with descriptor
.Fa elf
and stores it into the location pointed to by argument
.Fa shnum .
.Pp
This routine allows applications to uniformly process both normal ELF
objects, and ELF objects that use extended section numbering.
.Sh RETURN VALUES
Function
.Fn elf_getshdrnum
returns zero value if successful, or -1 in case of an error.
.Sh ERRORS
Function
.Fn elf_getshdrnum
can fail with the following errors:
.Bl -tag -width "[ELF_E_RESOURCE]"
.It Bq Er ELF_E_ARGUMENT
A
.Dv NULL
value was passed in for argument
.Fa elf .
.It Bq Er ELF_E_ARGUMENT
Argument
.Fa elf
was not for an ELF file.
.It Bq Er ELF_E_ARGUMENT
Argument
.Fa elf
lacks an ELF Executable header.
.El
.Sh SEE ALSO
.Xr elf 3 ,
.Xr elf32_getehdr 3 ,
.Xr elf64_getehdr 3 ,
.Xr elf_getident 3 ,
.Xr elf_getphdrnum 3 ,
.Xr elf_getshdrstrndx 3 ,
.Xr gelf 3 ,
.Xr gelf_getehdr 3