lib/libc/stdio/fread.3

   1 .\" Copyright (c) 1990, 1991, 1993
   2 .\"     The Regents of the University of California.  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. Neither the name of the University nor the names of its contributors
  17 .\"    may be used to endorse or promote products derived from this software
  18 .\"    without specific prior written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .\"     @(#)fread.3     8.2 (Berkeley) 3/8/94
  33 .\" $FreeBSD: src/lib/libc/stdio/fread.3,v 1.10 2007/01/09 00:28:06 imp Exp $
  34 .\" $DragonFly: src/lib/libc/stdio/fread.3,v 1.2 2003/06/17 04:26:46 dillon Exp $
  35 .\"
  36 .Dd March 8, 1994
  37 .Dt FREAD 3
  38 .Os
  39 .Sh NAME
  40 .Nm fread ,
  41 .Nm fwrite
  42 .Nd binary stream input/output
  43 .Sh LIBRARY
  44 .Lb libc
  45 .Sh SYNOPSIS
  46 .In stdio.h
  47 .Ft size_t
  48 .Fn fread "void * restrict ptr" "size_t size" "size_t nmemb" "FILE * restrict stream"
  49 .Ft size_t
  50 .Fn fwrite "const void * restrict ptr" "size_t size" "size_t nmemb" "FILE * restrict stream"
  51 .Sh DESCRIPTION
  52 The function
  53 .Fn fread
  54 reads
  55 .Fa nmemb
  56 objects, each
  57 .Fa size
  58 bytes long, from the stream pointed to by
  59 .Fa stream ,
  60 storing them at the location given by
  61 .Fa ptr .
  62 .Pp
  63 The function
  64 .Fn fwrite
  65 writes
  66 .Fa nmemb
  67 objects, each
  68 .Fa size
  69 bytes long, to the stream pointed to by
  70 .Fa stream ,
  71 obtaining them from the location given by
  72 .Fa ptr .
  73 .Sh RETURN VALUES
  74 The functions
  75 .Fn fread
  76 and
  77 .Fn fwrite
  78 advance the file position indicator for the stream
  79 by the number of bytes read or written.
  80 They return the number of objects read or written.
  81 If an error occurs, or the end-of-file is reached,
  82 the return value is a short object count (or zero).
  83 .Pp
  84 The function
  85 .Fn fread
  86 does not distinguish between end-of-file and error, and callers
  87 must use
  88 .Xr feof 3
  89 and
  90 .Xr ferror 3
  91 to determine which occurred.
  92 The function
  93 .Fn fwrite
  94 returns a value less than
  95 .Fa nmemb
  96 only if a write error has occurred.
  97 .Sh SEE ALSO
  98 .Xr read 2 ,
  99 .Xr write 2
 100 .Sh STANDARDS
 101 The functions
 102 .Fn fread
 103 and
 104 .Fn fwrite
 105 conform to
 106 .St -isoC .