lib/libelf/elf_getident.3

   1 .\" Copyright (c) 2006 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 .\" $FreeBSD$
  25 .\"
  26 .Dd July 3, 2006
  27 .Dt ELF_GETIDENT 3
  28 .Os
  29 .Sh NAME
  30 .Nm elf_getident
  31 .Nd return the initial bytes of a file
  32 .Sh LIBRARY
  33 .Lb libelf
  34 .Sh SYNOPSIS
  35 .In libelf.h
  36 .Ft char *
  37 .Fn elf_getident "Elf *elf" "size_t *sz"
  38 .Sh DESCRIPTION
  39 Function
  40 .Fn elf_getident
  41 returns a pointer to the initial bytes of the file for descriptor
  42 .Ar elf .
  43 .Pp
  44 If argument
  45 .Ar sz
  46 is non-null, the size of the identification area returned is written
  47 to the location pointed to by
  48 .Ar sz .
  49 This location is set to zero on errors.
  50 .Sh RETURN VALUES
  51 Function
  52 .Fn elf_getident
  53 will return a non-NULL pointer to the initial bytes of the file if
  54 successful, or NULL if an error condition is detected.
  55 .Sh ERRORS
  56 Function
  57 .Fn elf_getident
  58 can fail with the following errors:
  59 .Bl -tag -width "[ELF_E_RESOURCE]"
  60 .It Bq Er ELF_E_ARGUMENT
  61 A NULL value was passed in for argument
  62 .Ar elf .
  63 .It Bq Er ELF_E_SEQUENCE
  64 ELF descriptor
  65 .Ar elf
  66 was opened for writing and function
  67 .Fn elf_getident
  68 was called before a call to
  69 .Xr elf_update 3 .
  70 .El
  71 .Sh SEE ALSO
  72 .Xr elf 3 ,
  73 .Xr elf32_getehdr 3 ,
  74 .Xr elf64_getehdr 3 ,
  75 .Xr elf_getarhdr 3 ,
  76 .Xr elf_getbase 3 ,
  77 .Xr elf_getflags 3 ,
  78 .Xr elf_kind 3 ,
  79 .Xr elf_rawfile 3 ,
  80 .Xr elf_update 3 ,
  81 .Xr gelf 3 ,
  82 .Xr gelf_getclass 3 ,
  83 .Xr gelf_getehdr 3