vpGetError(3)

💖 vpGetError(3) 💖

okay bestie, welcome to the Library Functions Manual section for vpGetError(3) — yes, that's the manual page name, it's giving very "chapter title" of us but whatever, we move. this is the VolPack error-handling girlies' page and it is SO useful, fr fr 🫶

✨ NAME ✨

vpGetError, vpGetErrorString — retrieve error codes 👑

🌸 SYNOPSIS 🌸

#include <volpack.h>

vpResult
vpGetError(vpc)
    vpContext *vpc;

char *
vpGetErrorString(code)
    vpResult code;

🎀 ARGUMENTS 🎀

• vpc — the VolPack context you got from vpCreateContext. your whole vibe, basically. your main character object. 💅
• code — a VolPack error result code. the little number that says "something went wrong bestie". 😭

🦋 DESCRIPTION 🦋

so these routines?? they're for error handling. the whole point. the moment. ✨

vpGetError returns the error code from the first function call that failed since the last time you called vpGetError. yes — the first one. not the latest. the original problem child. keep that in mind, it matters.

vpGetErrorString returns a descriptive string that corresponds to an error code. it's giving "translating the cryptic number into actual words". 🧚

and here's the cute part: the string is stored in a global array, so you do not need to copy it to separate memory. no malloc, no strdup, no stress. just point at it and go. 🌈

💀 ERRORS 💀

vpGetError cannot fail. periodt. it's literally not capable of it. 💅

but if its return value is not equal to VP_OK?? that means some previous function call has failed. so it's not telling on itself, it's telling on somebody else. messy but valid. 🙈

vpGetErrorString returns NULL if code is invalid. so like, if you hand it a fake code, it just gives you nothing back. vibe check failed. 💀

👑 SEE ALSO 👑

VolPack(3), vpCreateContext(3)

that's the whole page bestie!! 🩷 this one shipped as part of the VolPack library — that's the source, that's the version, that's the whole ~lewk~ — and it lives at vpGetError(3) in the manual. go forth and handle your errors, you've got this, slay 💖✨🎀