xref: /illumos-gate/usr/src/man/man3elf/elf_kind.3elf (revision 2a6e99a0f1f7d22c0396e8b2ce9b9babbd1056cf)
te
Copyright 1989 AT&T Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved
The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
ELF_KIND 3ELF "Jul 11, 2001"
NAME
elf_kind - determine file type
SYNOPSIS

cc [ flag ... ] file ... -lelf [ library ... ]
#include <libelf.h>

Elf_Kind elf_kind(Elf *elf);
DESCRIPTION

This function returns a value identifying the kind of file associated with an ELF descriptor (elf). Defined values are below: ELF_K_AR

The file is an archive [see ar.h(3HEAD)]. An ELF descriptor may also be associated with an archive member, not the archive itself, and then elf_kind() identifies the member's type.

ELF_K_COFF

The file is a COFF object file. elf_begin(3ELF) describes the library's handling for COFF files.

ELF_K_ELF

The file is an ELF file. The program may use elf_getident() to determine the class. Other functions, such as elf32_getehdr(), are available to retrieve other file information.

ELF_K_NONE

This indicates a kind of file unknown to the library.

Other values are reserved, to be assigned as needed to new kinds of files. elf should be a value previously returned by elf_begin(). A null pointer is allowed, to simplify error handling, and causes elf_kind() to return ELF_K_NONE.

ATTRIBUTES

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPE ATTRIBUTE VALUE
Interface Stability Stable
MT-Level MT-Safe
SEE ALSO

ar.h(3HEAD), elf(3ELF), elf32_getehdr(3ELF), elf_begin(3ELF), elf_getident(3ELF), libelf(3LIB), attributes(5)