命名空间
变体
操作

fgets

来自 cppreference.com
< c‎ | io
 
 
文件输入/输出
类型和对象
函数
文件访问
直接输入/输出
无格式输入/输出
(C95)(C95)
(C95)
(C95)(C95)
(C95)
(C95)
格式化输入
(C99)(C99)(C99)(C11)(C11)(C11)     
 
定义在头文件 <stdio.h>
char* fgets( char*          str, int count, FILE*          stream );
(直到 C99)
char* fgets( char* restrict str, int count, FILE* restrict stream );
(自 C99)

从给定的文件流中读取最多 count - 1 个字符,并将它们存储在由 str 指向的字符数组中。如果找到换行符,解析停止(在这种情况下,str 将包含该换行符),或者如果遇到文件结尾。如果读取了字节并且没有发生错误,则在写入到 str 的最后一个字符之后的位置写入一个空字符。

内容

[编辑] 参数

str - 指向 char 数组元素的指针
count - 要写入的最大字符数(通常是 str 的长度)
stream - 要从中读取数据的文件流

[编辑] 返回值

成功时为 str,失败时为 null 指针。

如果遇到文件结尾条件,则在 stream 上设置 eof 指示器(参见 feof())。只有当它导致没有字节被读取时,这才是失败,在这种情况下,将返回一个 null 指针,并且由 str 指向的数组的内容不会改变(即第一个字节不会被覆盖为空字符)。

如果失败是由其他错误导致的,则设置 stream 上的 error 指示器(参见 ferror())。由 str 指向的数组的内容是不确定的(它甚至可能不被 null 终止)。

[编辑] 注意

POSIX 还要求 如果发生读取错误,则 fgets 设置 errno

虽然在 count <= 1 的情况下,标准规范是 不清楚的,但常见的实现会

  • 如果 count < 1,什么都不做,报告错误,
  • 如果 count == 1
  • 一些实现什么都不做,报告错误,
  • 其他一些实现什么都不读,在 str[0] 中存储零,报告成功。

[编辑] 示例

#include <stdio.h>
#include <stdlib.h>
 
int main(void)
{
    FILE* tmpf = tmpfile();
    fputs("Alan Turing\n", tmpf);
    fputs("John von Neumann\n", tmpf);
    fputs("Alonzo Church\n", tmpf);
 
    rewind(tmpf);
 
    char buf[8];
    while (fgets(buf, sizeof buf, tmpf) != NULL)
          printf("\"%s\"\n", buf);
 
    if (feof(tmpf))
       puts("End of file reached");
}

输出

"Alan Tu"
"ring
"
"John vo"
"n Neuma"
"nn
"
"Alonzo "
"Church
"
End of file reached

[编辑] 参考文献

  • C23 标准 (ISO/IEC 9899:2024)
  • 7.21.7.2 fgets 函数 (p: TBD)
  • C17 标准 (ISO/IEC 9899:2018)
  • 7.21.7.2 fgets 函数 (p: 241)
  • C11 标准 (ISO/IEC 9899:2011)
  • 7.21.7.2 fgets 函数 (p: 331)
  • C99 标准 (ISO/IEC 9899:1999)
  • 7.19.7.2 fgets 函数 (p: 296)
  • C89/C90 标准 (ISO/IEC 9899:1990)
  • 4.9.7.2 fgets 函数

[编辑] 参见

stdin、文件流或缓冲区中读取格式化的输入
(函数) [编辑]
(在 C11 中删除)(C11)
stdin 中读取一个字符串
(函数) [编辑]
将一个字符串写入文件流
(函数) [编辑]
从流中读取到自动调整大小的缓冲区中,直到分隔符/行尾
(函数) [编辑]
C++ 文档 for fgets