explain_fgets_or_die(3)

💖 explain_fgets_or_die(3) 💖

okay bestie, welcome to explain_fgets_or_die from the Library Functions Manual — she's a little libexplain gem and she's here to read you a string and handle the drama if things go wrong. no cap. 🎀

---

✨ NAME ✨

explain_fgets_or_die — input of strings and report errors 🌸

---

✨ SYNOPSIS ✨

#include <libexplain/fgets.h>
char *explain_fgets_or_die(char *data, int data_size, FILE *fp);

---

✨ DESCRIPTION ✨

so the way that explain_fgets_or_die works is: she calls the fgets(3) system call for you 🫶. and if that call fails? she prints an explanation to stderr — that explanation comes straight from explain_fgets(3) — and then the process terminates by calling exit(EXIT_FAILURE). yeah. she does not play. 💀

this function is intended to be used in a fashion similar to the following example:

explain_fgets_or_die(data, data_size, fp);

• data — the data, exactly as to be passed to the fgets(3) system call. literally just hand it over as-is, no edits 💅
• data_size — the data_size, exactly as to be passed to the fgets(3) system call. same energy, pass it through untouched ✨
• fp — the fp, exactly as to be passed to the fgets(3) system call. yes bestie, also exactly as-is 🦋

Returns:

this function only returns on success — she returns data when a line is read, or NULL on end-of-file 🌈. on failure, she prints an explanation and exits. so like... you only see her come back when it went well. otherwise, bye 👋

---

✨ SEE ALSO ✨

• fgets(3) — input of strings 📖
• explain_fgets(3) — explain fgets(3) errors 🔍
• exit(2) — terminate the calling process 💀

---

✨ COPYRIGHT ✨

libexplain version 1.4 Copyright (C) 2008 Peter Miller

---

okay that's the whole page, you ate that 🍓✨ it's giving libexplain version 1.4, Copyright (C) 2008 Peter Miller, and this was your girl explain_fgets_or_die(3) — mwah, take care of her, she's iconic 💖👑