draft/man3/fread.3

   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 .\" Japanese Version Copyright (c) 1997 YOSHINO Takashi
  44 .\"       all rights reserved.
  45 .\" Translated Tue Jan 21 21:57:33 JST 1997
  46 .\"       by YOSHINO Takashi <yoshino@civil.jcn.nihon-u.ac.jp>
  47 .\" Updated & Modified Mon Mar 1 1999
  48 .\"       by NAKANO Takeo <nakano@apm.seikei.ac.jp>
  49 .\" Updated Sat Nov  3 JST 2001 by Kentaro Shirakata <argrath@ub32.org>
  50 .\"
  51 .TH FREAD 3  1996-05-17 "GNU" "Linux Programmer's Manual"
  52 .SH 名前
  53 fread, fwrite \- バイナリストリームの入出力
  54 .SH 書式
  55 .nf
  56 .B #include <stdio.h>
  57 .sp
  58 .BI "size_t fread(void *" ptr ", size_t " size ", size_t " nmemb \
  59 ", FILE *" stream );
  60 .sp
  61 .BI "size_t fwrite(const void *" ptr ", size_t " size ", size_t " nmemb ,
  62 .BI "              FILE *" stream );
  63 .fi
  64 .SH 説明
  65 .BR fread ()
  66 関数は
  67 .I stream
  68 ポインタで指定されたストリームから
  69 .I nmemb
  70 個のデータを読み込み、
  71 .I ptr
  72 で与えられた場所に格納する。
  73 個々のデータは
  74 .I size
  75 バイトの長さを持つ。
  76 .PP
  77 .BR fwrite ()
  78 関数は
  79 .I ptr
  80 で指定された場所から得た
  81 .I nmemb
  82 個のデータを、
  83 .I stream
  84 ポインタで指定されたストリームに書き込む。
  85 個々のデータは
  86 .I size
  87 バイトの長さを持つ。
  88 .PP
  89 .\"O For nonlocking counterparts, see
  90 .\"O .BR unlocked_stdio (3).
  91 これらの処理を停止せずに行いたいときは、
  92 .BR unlocked_stdio (3)
  93 を参照のこと。
  94 .SH 返り値
  95 .BR fread ()
  96 と
  97 .BR fwrite ()
  98 は読み書きに成功した要素の個数を返す。
  99 エラーが生じた場合や、end-of-file(ファイルの最後)に達した場合、
 100 返り値は指定した個数よりも小さい値(またはゼロ)となる。
 101 .PP
 102 .BR fread ()
 103 は end-of-file とエラーを区別しないので、
 104 どちらが生じたかを判断するためには、
 105 呼び出し側で
 106 .BR feof (3)
 107 と
 108 .BR ferror (3)
 109 とを使用しなければならない。
 110 .SH 準拠
 111 C89, POSIX.1-2001.
 112 .SH 関連項目
 113 .BR read (2),
 114 .BR write (2),
 115 .BR feof (3),
 116 .BR ferror (3),
 117 .BR unlocked_stdio (3)