.\" Copyright (c) 1990, 1991, 1993
.\"	The Regents of the University of California.  All rights reserved.
.\"
.\" This code is derived from software contributed to Berkeley by
.\" Chris Torek and the American National Standards Committee X3,
.\" on Information Processing Systems.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 3. All advertising materials mentioning features or use of this software
.\"    must display the following acknowledgement:
.\"	This product includes software developed by the University of
.\"	California, Berkeley and its contributors.
.\" 4. Neither the name of the University nor the names of its contributors
.\"    may be used to endorse or promote products derived from this software
.\"    without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\"     @(#)fgets.3	8.1 (Berkeley) 6/4/93
.\"
.\" $FreeBSD$
.\"
.Dd June 4, 1993
.Dt FGETS 3
.Os
.Sh 名称
.Nm fgets ,
.Nm gets
.Nd ストリームからラインを入手
.Sh 書式
.Fd #include <stdio.h>
.Ft char *
.Fn fgets "char *str" "int size" "FILE *stream"
.Ft char *
.Fn gets "char *str"
.Sh 解説
.Fn fgets
関数は、最大で
.Fa size
が指定するキャラクタ数より 1 少ないキャラクタを
.Fa stream
から読み込み、ストリング
.Fa str
に保存します。
読込みは、改行キャラクタ、ファイルの終了、
エラーが見つかった場合に停止します。
存在する改行は保持されます。
キャラクタを読み込んでエラーが発生しなかった場合、
ストリングの最後には
.Ql \e0
キャラクタが付きます。
.Pp
.Fn gets
関数は、改行キャラクタが存在してもストリングに保存されないことを除けば、
.Fa size
を無限にして
.Fa stream
を
.Em stdin
にした
.Fn fgets
と同じです。呼び出し側では、
存在する入力ラインがストリングに収まる長さであることを
確認する必要があります。
.Sh 戻り値
問題なく終了すると、
.Fn fgets
と
.Fn gets
はストリングのポインタを戻します。
キャラクタを読み込む前にファイルの終了に達すると、
.Dv NULL
が戻されます。
この場合、バッファの内容は変化しません。エラーが発生すると
.Dv NULL
が戻され、バッファの内容は不定になります。
.Fn fgets
関数と
.Fn gets
関数はファイルの終了とエラーを区別しません。
ファイルの終了かエラーかを判断するには、呼び出し側が
.Xr feof 3
と
.Xr ferror 3
を使用する必要があります。
.Sh エラー
.Bl -tag -width [EBADF]
.It Bq Er EBADF
指定された
.Fa stream
が、読込み可能ストリームではありません。
.El
.Pp
.Fn fgets
関数がエラーになると、ルーチン
.Xr fflush 3 ,
.Xr fstat 2 ,
.Xr read 2 ,
.Xr malloc 3
に指定されたエラーに
.Va errno
が設定されることがあります。
.Pp
.Fn gets
関数がエラーになると、ルーチン
.Xr getchar 3
に指定されたエラーに
.Va errno
が設定されることがあります。
.Sh 関連項目
.Xr feof 3 ,
.Xr ferror 3 ,
.Xr fgetln 3
.Sh 規格
.Fn fgets
関数と
.Fn gets
関数は、
.St -ansiC
に準拠しています。
.Sh バグ
通常の場合は、
次の入力ラインが任意の長さより短いことを確認することは不可能で、
入力バッファがオーバフローすると必ずセキュリティ違反となるため、
プログラムでは
.Fn gets
を使用しないでください。
.Fn gets
は、
.St -ansiC
に準拠するために存在します。