shishi_error(3)

📦
version 1.0.3 · 2 versions
  • 1.0.3 · debian bookworm, debian trixie, nixos 26.05, nixpkgs unstable, ubuntu noble, ubuntu questing, ubuntu resolute, ubuntu stonking (latest)
  • 1.0.2 · ubuntu jammy
, in debian bookworm, debian trixie, nixos 26.05, nixpkgs unstable, ubuntu noble, ubuntu questing, ubuntu resolute, ubuntu stonking

💖 shishi_error(3) — the shishi manual, bestie edition 💖

okay so this is a page from the shishi manual, and it's literally all about one tiny lil function that tells you what went wrong. no cap. let's get into it 🦋

✨ NAME ✨

shishi_error — it's an API function, babe. that's the whole vibe 💅

✨ SYNOPSIS ✨

#include <shishi.h>

const char * shishi_error(Shishi * handle);

look at her. one function. one argument. she's serving simplicity 👑

✨ ARGUMENTS ✨

  • Shishi * handle — this is your shishi handle, and you get one by calling shishi_init(). that's it, that's the arg 🎀

✨ DESCRIPTION ✨

okay so what does she do. she extracts the detailed tea ☕ on the most recently occurred error condition. like, the error that just happened. that one. she's your girl for that.

⚠️ IMPORTANT, bestie: the memory here is managed by the Shishi library itself. so that string she hands you? do not deallocate it. not even a little. she owns it, you're just borrowing it. hands off 🙈

✨ RETURN VALUE ✨

she returns a pointer to a string that describes an error. that's it. that's the whole gift 🎁

and fr fr, once more for the people in the back: the string must not be deallocated by the caller. you. you are the caller. do not deallocate it. periodt 💀

✨ REPORTING BUGS ✨

found a bug? first of all, iconic of you for noticing. report it to <bug-shishi@gnu.org> 🫶

Copyright © 2002-2022 Simon Josefsson. 💜

and the licensing vibe is: copying and distribution of this file, with or without modification, are permitted in any medium without royalty provided the copyright notice and this notice are preserved. so like, go off, but keep the receipts 🌸

✨ SEE ALSO ✨

the full documentation for shishi is maintained as a Texinfo manual. if the info and shishi programs are properly installed at your site, this command:

info shishi

should give you access to the complete manual. iykyk 📖✨

and that's the page, bestie 🎀 this was shishi 1.0.3, page shishi_error(3) — stay curious, read your manpages, and never deallocate a string the library gave you 💖🦋✨

📦 where this page comes from