Annotation of src/external/bsd/elftoolchain/dist/libelf/elf_rawfile.3, Revision 1.1.1.2
1.1.1.2 ! christos 1: .\" $NetBSD$
! 2: .\"
1.1 christos 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_rawfile.3 189 2008-07-20 10:38:08Z jkoshy
27: .\"
28: .Dd July 3, 2006
29: .Os
30: .Dt ELF_RAWFILE 3
31: .Sh NAME
32: .Nm elf_rawfile
33: .Nd return uninterpreted contents of an ELF file
34: .Sh LIBRARY
35: .Lb libelf
36: .Sh SYNOPSIS
37: .In libelf.h
38: .Ft char *
39: .Fn elf_rawfile "Elf *elf" "size_t *sz"
40: .Sh DESCRIPTION
41: Function
42: .Fn elf_rawfile
43: returns the uninterpreted contents of the file referenced by ELF descriptor
44: .Ar elf .
45: .Pp
46: If argument
47: .Ar sz
48: is non-null, the function stores the file's size in bytes
49: in the location to which it points.
50: A value of zero is written to this location if an error is
51: encountered.
52: .Sh RETURN VALUES
53: Function
54: .Fn elf_rawfile
55: returns a valid pointer if successful or NULL if an error occurs.
56: .Sh ERRORS
57: Function
58: .Fn elf_rawfile
59: may fail with the following errors:
60: .Bl -tag -width "[ELF_E_RESOURCE]"
61: .It Bq Er ELF_E_ARGUMENT
62: Argument
63: .Ar elf
64: was NULL.
65: .It Bq Er ELF_E_SEQUENCE
66: Argument
67: .Ar elf
68: was opened for writing and function
69: .Fn elf_rawfile
70: was invoked before
71: .Xr elf_update 3 .
72: .El
73: .Sh SEE ALSO
74: .Xr elf 3 ,
75: .Xr elf_getdata 3 ,
76: .Xr elf_getident 3 ,
77: .Xr elf_kind 3 ,
78: .Xr elf_update 3
CVSweb <webmaster@jp.NetBSD.org>