external/bsd/elftoolchain/dist/libelf/gelf_getclass.3

   1 .\"     $NetBSD: gelf_getclass.3,v 1.2 2014/03/09 16:58:04 christos Exp $
   2 .\"
   3 .\" Copyright (c) 2006,2008 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 .\" Id: gelf_getclass.3 189 2008-07-20 10:38:08Z jkoshy
  27 .\"
  28 .Dd July 3, 2006
  29 .Os
  30 .Dt GELF_GETCLASS 3
  31 .Sh NAME
  32 .Nm gelf_getclass
  33 .Nd retrieve the class of an ELF descriptor
  34 .Sh LIBRARY
  35 .Lb libelf
  36 .Sh SYNOPSIS
  37 .In gelf.h
  38 .Ft int
  39 .Fn gelf_getclass "Elf *elf"
  40 .Sh DESCRIPTION
  41 Function
  42 .Fn gelf_getclass
  43 returns the ELF class of the descriptor supplied in argument
  44 .Ar elf .
  45 .Sh RETURN VALUES
  46 Function
  47 .Fn gelf_getclass
  48 will return one of
  49 .Dv ELFCLASS32
  50 or
  51 .Dv ELFCLASS64
  52 if the argument
  53 .Ar elf
  54 is a descriptor for an ELF file.
  55 The value
  56 .Dv ELFCLASSNONE
  57 is returned if argument
  58 .Ar elf
  59 was null, or if it was not a descriptor for an ELF file.
  60 .Sh SEE ALSO
  61 .Xr elf 3 ,
  62 .Xr elf_kind 3 ,
  63 .Xr gelf 3