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

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