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 ELF_RAWFILE 3
29  .Sh NAME
30  .Nm elf_rawfile
31  .Nd return uninterpreted contents of an ELF file
32  .Sh LIBRARY
33  .Lb libelf
34  .Sh SYNOPSIS
35  .In libelf.h
36  .Ft char *
37  .Fn elf_rawfile "Elf *elf" "size_t *sz"
38  .Sh DESCRIPTION
39  Function
40  .Fn elf_rawfile
41  returns the uninterpreted contents of the file referenced by ELF descriptor
42  .Ar elf .
43  .Pp
44  If argument
45  .Ar sz
46  is non-null, the function stores the file's size in bytes
47  in the location to which it points.
48  A value of zero is written to this location if an error is
49  encountered.
50  .Sh RETURN VALUES
51  Function
52  .Fn elf_rawfile
53  returns a valid pointer if successful or NULL if an error occurs.
54  .Sh ERRORS
55  Function
56  .Fn elf_rawfile
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  was NULL.
63  .It Bq Er ELF_E_SEQUENCE
64  Argument
65  .Ar elf
66  was opened for writing and function
67  .Fn elf_rawfile
68  was invoked before
69  .Xr elf_update 3 .
70  .El
71  .Sh SEE ALSO
72  .Xr elf 3 ,
73  .Xr elf_getdata 3 ,
74  .Xr elf_getident 3 ,
75  .Xr elf_kind 3 ,
76  .Xr elf_update 3