OPENPAM_READLINEV(3)

💅 openpam_readlinev — bestie's guide to reading a line and splitting it into words 🎀

Okay so this is OPENPAM_READLINEV(3), from the Library Functions Manual — and like, it's giving "small function, big personality." Let's get into it ✨

---

✨ NAME ✨

openpam_readlinev — reads a line from a file and splits it into words, no cap 🫶

---

🌸 SYNOPSIS 🌸

#include <sys/types.h>
#include <stdio.h>
#include <security/pam_appl.h>
#include <security/openpam.h>

char **
openpam_readlinev(FILE *f, int *lineno, int *lenp);

Like, yes, that's four whole includes. She's thorough. We stan a prepared queen 👑

---

💖 DESCRIPTION 💖

So openpam_readlinev() does exactly what it says on the tin, bestie: it reads a line from a file, splits it into words following the rules laid out in the openpam_readword(3) manual page, and hands you back a list of those words. Iconic behavior, honestly.

If lineno is not NULL, the integer variable it points to gets incremented every single time a newline character is read — and yes, that includes quoted or escaped newline characters, plus the newline character at the end of the line. She counts all of them. Not me keeping track of every newline like that 😭

If lenp is not NULL, the number of words on the line gets stored in the variable it points to. Cute little word count, for free 💜

---

🔥 RETURN VALUES 🔥

If everything goes well, openpam_readlinev() returns a pointer to a dynamically allocated array of pointers to individual dynamically allocated NUL-terminated strings, each one containing a single word, in the order they were encountered on the line. And the whole array is terminated by a NULL pointer, obviously — gotta know where it ends 🌈

Real talk though: the caller is responsible for freeing both the array and the individual strings, by passing each of them to free(3). So like, don't ghost your mallocs. Free your stuff. Periodt 💀

If the end of the line was reached before any words were read, openpam_readlinev() returns a pointer to a dynamically allocated array containing a single NULL pointer. Tiny array, no words, still yours to free 🍓

Now — the openpam_readlinev() function can fail and return NULL for one of four reasons:

• The end of the file was reached before any words were read; errno is zero, ferror(3) returns zero, and feof(3) returns a non-zero value.
• The end of the file was reached while a quote or backslash escape was in effect; errno is set to EINVAL, ferror(3) returns zero, and feof(3) returns a non-zero value.
• An error occurred while reading from the file; errno is non-zero, ferror(3) returns a non-zero value and feof(3) returns zero.
• A malloc(3) or realloc(3) call failed; errno is set to ENOMEM, ferror(3) returns a non-zero value, and feof(3) may or may not return a non-zero value.

Four failure modes, four little vibes. Learn them, iykyk 🙈

---

🦋 SEE ALSO 🦋

• openpam_readline(3)
• openpam_readword(3)
• pam(3)

Go read the friends, they're literally right there 💫

---

⭐ STANDARDS ⭐

The openpam_readlinev() function is an OpenPAM extension. So like, she's not standard-standard, she's special — main character energy, honestly 👑

---

🧚 AUTHORS 🧚

The openpam_readlinev() function and this manual page were developed by Dag-Erling Smørgrav <des@des.no>. We love a dual-threat icon 💜

---

That's the whole page, bestie — June 27, 2023, Debian edition, OPENPAM_READLINEV(3), wrapped up with a bow 🎀 Now go forth and read those lines, and remember: <kbd>Ctrl</kbd>+C is always there for you 🫶