2 .\" Copyright (c) 1990, 1991 The Regents of the University of California.
3 .\" and Copyright (c) 2020 Arkadiusz Drabczyk <arkadiusz@drabczyk.org>
4 .\" All rights reserved.
6 .\" This code is derived from software contributed to Berkeley by
7 .\" Chris Torek and the American National Standards Committee X3,
8 .\" on Information Processing Systems.
10 .\" SPDX-License-Identifier: BSD-4-Clause-UC
12 .\" @(#)fread.3 6.6 (Berkeley) 6/29/91
14 .\" Converted for Linux, Mon Nov 29 15:37:33 1993, faith@cs.unc.edu
15 .\" Sun Feb 19 21:26:54 1995 by faith, return values
16 .\" Modified Thu Apr 20 20:43:53 1995 by Jim Van Zandt <jrv@vanzandt.mv.com>
17 .\" Modified Fri May 17 10:21:51 1996 by Martin Schulze <joey@infodrom.north.de>
19 .TH fread 3 (date) "Linux man-pages (unreleased)"
21 fread, fwrite \- binary stream input/output
24 .RI ( libc ", " \-lc )
29 .BI "size_t fread(void " ptr "[restrict ." size " * ." nmemb ],
30 .BI " size_t " size ", size_t " nmemb ,
31 .BI " FILE *restrict " stream );
32 .BI "size_t fwrite(const void " ptr "[restrict ." size " * ." nmemb ],
33 .BI " size_t " size ", size_t " nmemb ,
34 .BI " FILE *restrict " stream );
43 bytes long, from the stream pointed to by
45 storing them at the location given by
54 bytes long, to the stream pointed to by
56 obtaining them from the location given by
59 For nonlocking counterparts, see
60 .BR unlocked_stdio (3).
66 return the number of items read or written.
67 This number equals the number of bytes transferred only when
70 If an error occurs, or the end of the file is reached,
71 the return value is a short item count (or zero).
73 The file position indicator for the stream is advanced by the number
74 of bytes successfully read or written.
77 does not distinguish between end-of-file and error, and callers must use
81 to determine which occurred.
83 For an explanation of the terms used in this section, see
89 Interface Attribute Value
95 T} Thread safety MT-Safe
103 The program below demonstrates the use of
105 by parsing /bin/sh ELF executable in binary mode and printing its
111 ELF magic: 0x7f454c46
117 .\" SRC BEGIN (fread.c)
122 #define ARRAY_SIZE(arr) (sizeof(arr) / sizeof((arr)[0]))
129 unsigned char buffer[4];
131 fp = fopen("/bin/sh", "rb");
137 ret = fread(buffer, sizeof(*buffer), ARRAY_SIZE(buffer), fp);
138 if (ret != ARRAY_SIZE(buffer)) {
139 fprintf(stderr, "fread() failed: %zu\en", ret);
143 printf("ELF magic: %#04x%02x%02x%02x\en", buffer[0], buffer[1],
144 buffer[2], buffer[3]);
146 ret = fread(buffer, 1, 1, fp);
148 fprintf(stderr, "fread() failed: %zu\en", ret);
152 printf("Class: %#04x\en", buffer[0]);
165 .BR unlocked_stdio (3)