lib/libelf/gelf_getclass.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 .\" $Id$
  25 .\"
  26 .Dd July 3, 2006
  27 .Os
  28 .Dt GELF_GETCLASS 3
  29 .Sh NAME
  30 .Nm gelf_getclass
  31 .Nd retrieve the class of an ELF descriptor
  32 .Sh LIBRARY
  33 .Lb libelf
  34 .Sh SYNOPSIS
  35 .In gelf.h
  36 .Ft int
  37 .Fn gelf_getclass "Elf *elf"
  38 .Sh DESCRIPTION
  39 Function
  40 .Fn gelf_getclass
  41 returns the ELF class of the descriptor supplied in argument
  42 .Ar elf .
  43 .Sh RETURN VALUES
  44 Function
  45 .Fn gelf_getclass
  46 will return one of
  47 .Dv ELFCLASS32
  48 or
  49 .Dv ELFCLASS64
  50 if the argument
  51 .Ar elf
  52 is a descriptor for an ELF file.
  53 The value
  54 .Dv ELFCLASSNONE
  55 is returned if argument
  56 .Ar elf
  57 was null, or if it was not a descriptor for an ELF file.
  58 .Sh SEE ALSO
  59 .Xr elf 3 ,
  60 .Xr elf_kind 3 ,
  61 .Xr gelf 3