VistaIOError(3)

💖 VistaIOError(3) — Library Functions Manual 💖

okay bestie, listen up: this is the page for VistaIOError and VistaIOSystemError, and their whole entire job is reporting a fatal error. that's it. that's the vibe. 🫶

---

✨ NAME ✨

VistaIOError, VistaIOSystemError — report a fatal error 💀

---

✨ SYNOPSIS ✨

void VistaIOError (format [, arg...])
       VistaIOStringConst format;

void VistaIOSystemError (format [, arg...])
       VistaIOStringConst format;

---

✨ ARGUMENTS ✨

• format — this is the format of the message you're about to report. the blueprint, the aesthetic, the whole look. 💅
• arg — the values that get dropped into that formatted message. the little guys that make it personal. 🎀

---

✨ DESCRIPTION ✨

so, VistaIOError is what you call when you need to report a fatal error. it puts together an error message and hands it off to the fatal error handler, which — typically — prints that message and then terminates the program. yes, like, the whole program. (peep VistaIOSetErrorHandler(3) if you wanna know more about that handler situation.)

the message that VistaIOError composes looks exactly like this:

Program: Fatal: Description.

Program is your program's name, and it only shows up if you already established it earlier with a call to VistaIOSetProgramName. Description is a string that has been formatted by sprintf using format, plus all of the optional arguments, arg. slay.

VistaIOSystemError is identical to VistaIOError except — plot twist — it also throws in a phrase based on the current value of the external variable errno, which is the thing system calls use to return diagnostic codes. the message VistaIOSystemError composes looks like:

Program: Fatal: Description: Diagnostic.

Diagnostic is a short phrase corresponding to the value of errno. and this phrase is drawn from the table used by perror(3). iykyk. 🌈

---

✨ RETURN VALUES ✨

neither VistaIOError nor VistaIOSystemError ever return. not once. not ever. they are not coming back. 😭

fr fr, plan accordingly — there is no "after" for these two.

---

✨ EXAMPLES ✨

first up: in this example, the values of attr_name, act_value, and exp_value get incorporated into the error message produced by VistaIOError.

char *attr_name;
float act_value, exp_value;

if (act_value != exp_value)
     VistaIOError ("MyRoutine: Attribute %s is %f rather than %f",
          attr_name, act_value, exp_value);

and second: here, the diagnostic phrase corresponding to the value of errno gets incorporated into the error message produced by VistaIOSystemError.

if (ioctl (fd, request, arg) == -1)
     VistaIOSystemError ("MyRoutine: ioctl failed");

---

✨ SEE ALSO ✨

• VistaIOWarning(3)
• VistaIOSetErrorHandler(3)
• VistaIOSetProgramName(3)
• , ← yes bestie there is a lil stray comma in here, i'm keeping it, character for character, no cap 🫶
• perror(3)

---

✨ AUTHOR ✨

Art Pope <pope@cs.ubc.ca> 👑

Adaption to vistaio: Gert Wollny <gw.fossdev@gmail.com> 🌸

---

and that's the whole page, periodt. this was VistaIO Version 1.2.14, dated 24 April 1993 — yeah, it's vintage, it's iconic, it's giving library-functions-manual royalty 👑✨ bye bestie, don't call VistaIOError unless you mean it 💜