al_fgets(3alleg5)

💖 al_fgets 💖

okay bestie, so this is the Allegro 5 API page for al_fgets — she's a little file-reading icon in the 3alleg5 manual and she's here to hand you one whole line, no cap 🫶

---

✨ SYNOPSIS ✨

#include <allegro5/allegro.h>

char *al_fgets(ALLEGRO_FILE *f, char * const buf, size_t max)

---

🌸 DESCRIPTION 🌸

So basically? You give her a buffer, and she reads a string of bytes into it, stopping when she hits a newline or end-of-file. That's the whole vibe 💅

And listen — the line terminator(s), if there even are any, are included in the returned string. She does not strip them, she does not play games, they come along for the ride fr fr.

Here's the tea on how much she reads: a maximum of max-1 bytes get read, and that one leftover byte is reserved for the NUL terminator. So she's always saving room to close the string off properly. Thoughtful queen behavior honestly 😭👑

Parameters, let's go:

• f — the file you're reading from 🍓
• buf — the buffer you're filling up
• max — the maximum size of the buffer

What she gives back 🎀

Returns the pointer to buf on success. Returns NULL if an error happened, or if the end of file was reached without reading any bytes. So like — if she read nothing at all, it's a NULL situation, periodt.

Heads up bestie: go check al_fopen(3alleg5) if you wanna know about translations of end-of-line characters, because that's where that whole story lives ✨

---

🦋 SEE ALSO 🦋

• al_fget_ustr(3alleg5)

---

and that's the page!! 💜 this was the Allegro reference manual, al_fgets(3alleg5), mwah — go read some lines, you got this 👑🌸