1.\" Copyright (c) 2006,2008,2010 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: elf_getbase.3 3639 2018-10-14 14:07:02Z jkoshy $ 25.\" 26.Dd June 6, 2010 27.Dt ELF_GETBASE 3 28.Os 29.Sh NAME 30.Nm elf_getbase 31.Nd get the base offset for an object file 32.Sh LIBRARY 33.Lb libelf 34.Sh SYNOPSIS 35.In libelf.h 36.Ft off_t 37.Fn elf_getbase "Elf *elf" 38.Sh DESCRIPTION 39Function 40.Fn elf_getbase 41returns the file offset to the first byte of the object referenced by ELF 42descriptor 43.Ar elf . 44.Pp 45For descriptors referencing members of archives, the returned offset is 46the file offset of the member in its containing archive. 47For descriptors to regular objects, the returned offset is (vacuously) 48zero. 49.Sh RETURN VALUES 50Function 51.Fn elf_getbase 52returns a valid file offset if successful, or 53.Pq Vt off_t 54.Li -1 55in case of an error. 56.Sh ERRORS 57Function 58.Fn elf_getbase 59may fail with the following errors: 60.Bl -tag -width "[ELF_E_RESOURCE]" 61.It Bq Er ELF_E_ARGUMENT 62Argument 63.Ar elf 64was NULL. 65.El 66.Sh SEE ALSO 67.Xr elf 3 , 68.Xr elf_getarhdr 3 , 69.Xr elf_getident 3 , 70.Xr elf_rawfile 3 , 71.Xr gelf 3 72