external/bsd/libelf/dist/elf_getbase.3

   1 .\"     $NetBSD$
   2 .\"
   3 .\" Copyright (c) 2006 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 .\" $FreeBSD: src/lib/libelf/elf_getbase.3,v 1.2.10.1.2.1 2009/10/25 01:10:29 kensmith Exp $
  27 .\"
  28 .Dd June 11, 2006
  29 .Os
  30 .Dt ELF_GETBASE 3
  31 .Sh NAME
  32 .Nm elf_getbase
  33 .Nd get the base offset for an object file
  34 .Sh LIBRARY
  35 .Lb libelf
  36 .Sh SYNOPSIS
  37 .In libelf.h
  38 .Ft off_t
  39 .Fn elf_getbase "Elf *elf"
  40 .Sh DESCRIPTION
  41 Function
  42 .Fn elf_getbase
  43 returns the file offset in the containing archive of the first byte of
  44 the file referenced by ELF descriptor
  45 .Ar elf .
  46 .Sh RETURN VALUES
  47 Function
  48 .Fn elf_getbase
  49 returns a valid file offset into the containing archive if successful.
  50 It returns -1 if argument
  51 .Ar elf
  52 is NULL or is not a member of an
  53 archive.
  54 .Sh ERRORS
  55 Function
  56 .Fn elf_getbase
  57 may fail with the following errors:
  58 .Bl -tag -width "[ELF_E_RESOURCE]"
  59 .It Bq Er ELF_E_ARGUMENT
  60 Argument
  61 .Ar elf
  62 is not an ELF descriptor for an archive member.
  63 .El
  64 .Sh SEE ALSO
  65 .Xr elf 3 ,
  66 .Xr elf_getarhdr 3 ,
  67 .Xr elf_getident 3 ,
  68 .Xr elf_rawfile 3 ,
  69 .Xr gelf 3