xref: /386bsd/usr/src/lib/libc/stdio/fread.3 (revision a2142627)
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.Dd June 29, 1991
39.Dt FREAD 3
40.Os
41.Sh NAME
42.Nm fread ,
43.Nm fwrite
44.Nd binary stream input/output
45.Sh SYNOPSIS
46.Fd #include <stdio.h>
47.Ft int
48.Fn fread "void *ptr" "size_t size" "size_t nmemb" "FILE *stream"
49.Ft int
50.Fn fwrite "void *ptr" "size_t size" "size_t nmemb" "FILE *stream"
51.Sh DESCRIPTION
52The function
53.Fn fread
54reads
55.Fa nmemb
56elements of data, each
57.Fa size
58bytes long, from the stream pointed to by
59.Fa stream ,
60storing them at the location given by
61.Fa ptr .
62.Pp
63The function
64.Fn fwrite
65writes
66.Fa nmemb
67elements of data, each
68.Fa size
69bytes long, to the stream pointed to by
70.Fa stream ,
71obtaining them from the location given by
72.Fa ptr .
73.Sh RETURN VALUES
74The functions
75.Fn fread
76and
77.Fn fwrite
78advance the file position indicator for the stream
79by the number of characters successfully read or written and return
80that number.
81If an error occurs, or the end-of-file is reached,
82the return value is a short character count (or zero).
83.Pp
84The function
85.Fn fread
86does not distinguish between end-of-file and error, and callers
87must use
88.Xr feof 3
89and
90.Xr ferror 3
91to determine which occurred.
92.Sh SEE ALSO
93.Xr read 2 ,
94.Xr write 2
95.Sh STANDARDS
96The functions
97.Fn fread
98and
99.Fn fwrite
100conform to
101.St -ansiC .
102