manual/LDP_man-pages/release/man3/fseek.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 .\"     @(#)fseek.3     6.11 (Berkeley) 6/29/91
  37 .\"
  38 .\" Converted for Linux, Mon Nov 29 15:22:01 1993, faith@cs.unc.edu
  39 .\"
  40 .\"
  41 .\" Japanese Version Copyright (c) 1998 NAKANO Takeo all rights reserved.
  42 .\" Translated Mon Apr 27 1998 by NAKANO Takeo <nakano@apm.seikei.ac.jp>
  43 .\"
  44 .\" WORD:       file position indicator ファイル位置表示子
  45 .\" WORD:       error indicator         エラー表示子
  46 .\"
  47 .TH FSEEK 3  1993-11-29 "GNU" "Linux Programmer's Manual"
  48 .SH 名前
  49 fgetpos, fseek, fsetpos, ftell, rewind \- ストリームの位置を変更する
  50 .SH 書式
  51 .B #include <stdio.h>
  52 .sp
  53 .BI "int fseek(FILE *" stream ", long " offset ", int " whence );
  54
  55 .BI "long ftell(FILE *" stream );
  56
  57 .BI "void rewind(FILE *" stream );
  58
  59 .BI "int fgetpos(FILE *" stream ", fpos_t *" pos );
  60 .br
  61 .BI "int fsetpos(FILE *" stream ", fpos_t *" pos );
  62 .SH 説明
  63 .BR fseek ()
  64 関数は
  65 .I stream
  66 によって指定されたストリームにおいて、ファイル位置表示子
  67 (file position indicator) をセットする。新たな位置 (バイト単位)
  68 は
  69 .I whence
  70 で指定された位置に
  71 .I offset
  72 バイトを加えることによって与えられる。
  73 .I whence
  74 が
  75 .BR SEEK_SET ,
  76 .BR SEEK_CUR ,
  77 .B SEEK_END
  78 のどれかになっている場合は、それぞれファイルの先頭、現在の位置表示子、
  79 ファイルの末尾からのオフセットが取られる。
  80 .BR fseek ()
  81 関数の呼び出しが成功すると、ストリームの end-of-file 表示子は
  82 クリアされ、それまでに
  83 .BR ungetc (3)
  84 関数で戻したデータはなかったことになる。
  85 .PP
  86 .BR ftell ()
  87 関数は
  88 .I stream
  89 によって指定されたストリームにおける、ファイル位置表示子
  90 の現時点での値を与える。
  91 .PP
  92 .BR rewind ()
  93 関数は
  94 .I stream
  95 によって指定されたストリームにおいて、ファイル位置表示子
  96 をファイルの先頭にセットする。この関数は以下と等価である。
  97 .PP
  98 .RS
  99 (void) fseek(stream, 0L, SEEK_SET)
 100 .RE
 101 .PP
 102 ただし
 103 .BR rewind ()
 104 ではストリームに対するエラー表示子 (error indicator) も同時に
 105 クリアされる (
 106 .BR clearerr (3)
 107 を見よ)。
 108 .PP
 109 .BR fgetpos ()
 110 関数と
 111 .BR fsetpos ()
 112 関数は、それぞれ
 113 .BR ftell ()
 114 と
 115 .BR fseek ()
 116 で
 117 .I whence
 118 に
 119 .B SEEK_SET
 120 を指定した場合と同様の機能を、異なるインターフェースで提供する。
 121 .BR fgetpos ()
 122 はファイルオフセットの現在の値を
 123 .I pos
 124 が参照するオブジェクトに保存し、
 125 .BR fsetpos ()
 126 はファイルオフセットを
 127 .I pos
 128 に設定する。
 129 UNIX 以外のシステムにおいては、
 130 .I fpos_t
 131 が構造体などの複雑なオブジェクトになっていて、これらのルーチンがテキス
 132 トストリームでファイル位置を変更する方法のうち、移植性のある唯一のもの
 133 になっている場合もある。
 134 .SH 返り値
 135 .BR rewind ()
 136 は返り値を持たない。
 137 .BR fgetpos (),
 138 .BR fseek (),
 139 .BR fsetpos ()
 140 は成功すると 0 を返す。
 141 .BR ftell ()
 142 は現在のオフセットを返す。失敗した場合は返り値は \-1 となり、
 143 .I errno
 144 にエラーを示す値がセットされる。
 145 .SH エラー
 146 .TP
 147 .B EBADF
 148 指定した
 149 .I stream
 150 がシークできない。
 151 .TP
 152 .B EINVAL
 153 .BR fseek ()
 154 関数に対して与えた
 155 .I whence
 156 引数が
 157 .BR SEEK_SET ,
 158 .BR SEEK_END ,
 159 .B SEEK_CUR
 160 以外の値であった。
 161 .PP
 162 .BR fgetpos (),
 163 .BR fseek (),
 164 .BR fsetpos (),
 165 .BR ftell ()
 166 は、それぞれ
 167 .BR fflush (3),
 168 .BR fstat (2),
 169 .BR lseek (2),
 170 .BR malloc (3)
 171 などのルーチンを呼び出す際に失敗する可能性がある。この場合は
 172 それぞれ対応した
 173 .I errno
 174 が設定される。
 175 .SH 準拠
 176 C89, C99.
 177 .SH 関連項目
 178 .BR lseek (2),
 179 .BR fseeko (3)