std::fgetpos(3)

💅 std::fgetpos(3) — C++ Standard Libary 💅

okay bestie, we are in the C++ Standard Libary manual, page std::fgetpos(3), and this one is short but lowkey iconic. Let’s get into it ✨

💖 NAME 💖

std::fgetpos — std::fgetpos. That’s the name. That’s the whole name. periodt 💅

🌸 Synopsis 🌸

Defined in header <cstdio>.

int fgetpos( std::FILE* stream, std::fpos_t* pos );

So what does it do? It obtains the file position indicator and the current parse state (if any) for the file stream stream, and stores them in the object pointed to by pos. The value stored is only meaningful as the input to std::fsetpos. Like, do not try to read it as some normal number, bestie — that is not the vibe check it passes 😭

🎀 Parameters 🎀

• stream — the file stream to examine.
• pos — pointer to a fpos_t object to store the file position indicator to.

✨ Return value ✨

Returns 0 upon success, nonzero value otherwise. Also sets errno on failure. So yeah, check that return value and check errno, no cap 🫶

🦋 Example 🦋

This section is incomplete.

Reason: no example.

not the incomplete example section 😭 it’s giving “trust me bestie, imagine a file stream here” 💀

🌈 See also 🌈

• ftell — returns the current file position indicator (function)
• fseek — moves the file position indicator to a specific location in a file (function)
• fsetpos — moves the file position indicator to a specific location in a file (function)
• C documentation for fgetpos

👑 Category 👑

• * Todo no example

and that’s the page, bestie 💖 source/version/date check: http://cppreference.com · 2024.06.10 · std::fgetpos(3) — bye, slay, and may your file positions be exactly where you left them 🎀✨