#C 语言标准库函数 fgets

/*********************************************
 * @brief 从文件中读取一行字符串
 * @param[out] str 保存读取到的字符串
 * @param n 字符串长度
 * @param fp 要读取的文件流
 * @return 读取到的字符串
 ********************************************/
char* fgets(char* restrict str, int n, FILE *restrict fp);

说明

从文件流 fp 中读取 n - 1 个字节的字符，保存到 str 中，并在末尾自动添加结束字符 '\0'。

如果遇到换行符（\n）或文件末尾，则提前结束读取；前者的结果中包含换行符。

参数

• str - 指向用于保存字符串的内存空间
• n - 保存字符串的内存空间长度（含结尾的 0）
• fp - 要读取的文件流

返回值

• 返回参数 str 本身
• 失败时返回 NULL

#示例

#include <stdio.h>

int main(void)
{
    // 打开文件
    FILE* fp = tmpfile();

    if (fp == NULL)
    {
        perror("文件打开失败");
        return 1;
    }

    // 写入文件
    fputs("0123456789\n0123456789", fp);

    // 重置位置
    rewind(fp);

    // 读取文件
    char str[32];
    fgets(str, 5, fp); // 读取 4 个字节
    printf("%s\n", str);
    fgets(str, 32, fp); // 读取 32 个字节
    printf("%s\n", str);

    // 关闭文件
    fclose(fp);

    return 0;
}

运行结果：

0123
456789

说明：

第一次读取时存储空间长度为 5，读取 4 个字符， 并添加字符串结尾的 0。

第二次读取时存储空间长度为 32，遇到换行符（\n）提前结束读取。

#推荐阅读

• C 语言标准库函数 fread
• C 语言标准库函数 fwrite
• C 语言标准库函数 fgetc
• C 语言标准库函数 fputc
• C 语言标准库函数 fputs
• fgets - cppreference
• fgets - POSIX

#参考标准

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