]>
Commit | Line | Data |
---|---|---|
fea681da MK |
1 | .\" Copyright (c) 1990, 1991 The Regents of the University of California. |
2 | .\" All rights reserved. | |
3 | .\" | |
4 | .\" This code is derived from software contributed to Berkeley by | |
5 | .\" Chris Torek and the American National Standards Committee X3, | |
6 | .\" on Information Processing Systems. | |
7 | .\" | |
8 | .\" Redistribution and use in source and binary forms, with or without | |
9 | .\" modification, are permitted provided that the following conditions | |
10 | .\" are met: | |
11 | .\" 1. Redistributions of source code must retain the above copyright | |
12 | .\" notice, this list of conditions and the following disclaimer. | |
13 | .\" 2. Redistributions in binary form must reproduce the above copyright | |
14 | .\" notice, this list of conditions and the following disclaimer in the | |
15 | .\" documentation and/or other materials provided with the distribution. | |
16 | .\" 3. All advertising materials mentioning features or use of this software | |
17 | .\" must display the following acknowledgement: | |
18 | .\" This product includes software developed by the University of | |
19 | .\" California, Berkeley and its contributors. | |
20 | .\" 4. Neither the name of the University nor the names of its contributors | |
21 | .\" may be used to endorse or promote products derived from this software | |
22 | .\" without specific prior written permission. | |
23 | .\" | |
24 | .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND | |
25 | .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE | |
26 | .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE | |
27 | .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE | |
28 | .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL | |
29 | .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS | |
30 | .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) | |
31 | .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT | |
32 | .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY | |
33 | .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF | |
34 | .\" SUCH DAMAGE. | |
35 | .\" | |
36 | .\" @(#)fread.3 6.6 (Berkeley) 6/29/91 | |
37 | .\" | |
38 | .\" Converted for Linux, Mon Nov 29 15:37:33 1993, faith@cs.unc.edu | |
39 | .\" Sun Feb 19 21:26:54 1995 by faith, return values | |
40 | .\" Modified Thu Apr 20 20:43:53 1995 by Jim Van Zandt <jrv@vanzandt.mv.com> | |
41 | .\" Modified Fri May 17 10:21:51 1996 by Martin Schulze <joey@infodrom.north.de> | |
42 | .\" | |
43 | .TH FREAD 3 1996-05-17 "BSD MANPAGE" "Linux Programmer's Manual" | |
44 | .SH NAME | |
45 | fread, fwrite \- binary stream input/output | |
46 | .SH SYNOPSIS | |
b9f02710 | 47 | .nf |
fea681da MK |
48 | .B #include <stdio.h> |
49 | .sp | |
b9f02710 MK |
50 | .BI "size_t fread(void *" ptr ", size_t " size ", size_t " nmemb \ |
51 | ", FILE *" stream ); | |
fea681da MK |
52 | .sp |
53 | .BI "size_t fwrite(const void *" ptr ", size_t " size ", size_t " nmemb , | |
b9f02710 MK |
54 | .BI " FILE *" stream ); |
55 | .fi | |
fea681da MK |
56 | .SH DESCRIPTION |
57 | The function | |
e511ffb6 | 58 | .BR fread () |
fea681da MK |
59 | reads |
60 | .I nmemb | |
61 | elements of data, each | |
62 | .I size | |
63 | bytes long, from the stream pointed to by | |
64 | .IR stream , | |
65 | storing them at the location given by | |
66 | .IR ptr . | |
67 | .PP | |
68 | The function | |
e511ffb6 | 69 | .BR fwrite () |
fea681da MK |
70 | writes |
71 | .I nmemb | |
72 | elements of data, each | |
73 | .I size | |
74 | bytes long, to the stream pointed to by | |
75 | .IR stream , | |
76 | obtaining them from the location given by | |
77 | .IR ptr . | |
78 | .PP | |
79 | For non-locking counterparts, see | |
80 | .BR unlocked_stdio (3). | |
81 | .SH "RETURN VALUE" | |
e511ffb6 | 82 | .BR fread () |
fea681da | 83 | and |
e511ffb6 | 84 | .BR fwrite () |
fea681da MK |
85 | return the number of items successfully read or written (i.e., not the |
86 | number of characters). If an error occurs, or the end-of-file is | |
87 | reached, the return value is a short item count (or zero). | |
88 | .PP | |
e511ffb6 | 89 | .BR fread () |
fea681da MK |
90 | does not distinguish between end-of-file and error, and callers must use |
91 | .BR feof (3) | |
92 | and | |
93 | .BR ferror (3) | |
94 | to determine which occurred. | |
95 | .SH "CONFORMING TO" | |
68e1685c | 96 | C89, POSIX.1-2001. |
fea681da MK |
97 | .SH "SEE ALSO" |
98 | .BR read (2), | |
99 | .BR write (2), | |
100 | .BR feof (3), | |
101 | .BR ferror (3), | |
102 | .BR unlocked_stdio (3) |