xref: /freebsd/contrib/elftoolchain/libelf/elf_kind.3 (revision ae500c1ff8974130f7f2692772cf288b90349e0d)
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.\" $Id: elf_kind.3 3639 2018-10-14 14:07:02Z jkoshy $
25.\"
26.Dd June 1, 2006
27.Dt ELF_KIND 3
28.Os
29.Sh NAME
30.Nm elf_kind
31.Nd determine ELF file type
32.Sh LIBRARY
33.Lb libelf
34.Sh SYNOPSIS
35.In libelf.h
36.Ft Elf_Kind
37.Fn elf_kind "Elf *elf"
38.Sh DESCRIPTION
39The
40.Fn elf_kind
41function identifies the kind of file associated with its argument
42.Ar elf .
43The argument
44.Ar elf
45is allowed to be NULL.
46.Sh RETURN VALUES
47The
48.Fn elf_kind
49function returns one of the following values:
50.Bl -tag -width indent
51.It Dv ELF_K_AR
52The file associated with argument
53.Ar elf
54is an archive.
55.It Dv ELF_K_ELF
56The file associated with argument
57.Ar elf
58is an ELF file.
59.It Dv ELF_K_NONE
60The argument
61.Ar elf
62was NULL, or the ELF library could not determine the type of the file
63associated with argument
64.Ar elf ,
65or an error occurred when processing.
66.El
67.Sh SEE ALSO
68.Xr elf 3 ,
69.Xr elf_begin 3 ,
70.Xr elf_getident 3 ,
71.Xr gelf 3
72