al_fseek(3alleg5)

📦
version 5.2.11.3 · 4 versions
, in debian trixie, ubuntu questing, ubuntu resolute, ubuntu stonking

💖 al_fseek — the Allegro 5 API glow-up 💖

okay bestie, welcome to the <pink>al_fseek</pink> page from the Allegro 5 reference manual. it's a file-positioning baddie and she's here to help you move around a file like it's your own personal group chat. no cap, let's get into it. 🦋

✨ NAME ✨

al_fseek — Allegro 5 API

🌸 SYNOPSIS 🌸

#include <allegro5/allegro.h>

bool al_fseek(ALLEGRO_FILE *f, int64_t offset, int whence)

💅 DESCRIPTION 💅

so what she does is: she sets the current position of the file f to a spot that's relative to whatever whence says, plus offset number of bytes. literally just "move the lil cursor to here." periodt. ✨

whence can be one of these three icons:

  • ALLEGRO_SEEK_SET — seek relative to the beginning of the file 🎀
  • ALLEGRO_SEEK_CUR — seek relative to the current file position 🫶
  • ALLEGRO_SEEK_END — seek relative to the end</end> of the file 🌈
wait, fix that tag: relative to the end of the file 🌈

She returns true on success and false on failure, and when she fails, errno is set to indicate the error. so like, check it. errno is the receipts. 😭

After a successful seek, two things happen that you should know about:

  • the end-of-file indicator gets cleared 🧹
  • all pushback bytes are forgotten 💀 (yes, forgotten forgotten, they're gone)
⚠️ real talk: on some platforms this function may not support large files. so if you're out here with a giant file and it's giving weird, that might be why. not her fault, it's the platform. 🙈

👑 SEE ALSO 👑

and that's the whole vibe bestie 💜 this was al_fseek straight outta the Allegro reference manual, page al_fseek(3alleg5). go forth and seek responsibly, mwah 💋

📦 where this page comes from