shishi_error_set(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_set(3) β€” the shishi manual, bestie edition πŸ’–

okay so we're deep in the shishi manual pages rn and this one is literally about telling shishi what went wrong. sit down, grab a boba, we're doing error strings 🫢


✨ NAME ✨

shishi_error_set β€” it's an API function, bestie. that's the whole vibe.


🌸 SYNOPSIS 🌸

#include <shishi.h>

void shishi_error_set(Shishi * handle, const char * errstr);

πŸŽ€ ARGUMENTS πŸŽ€

  • Shishi * handle β€” the shishi handle, and like... you get this from shishi_init(). it's the main character of every shishi function fr.
  • const char * errstr β€” a null-terminated character string holding a description. or NULL to clear the internal error string. yes you can just wipe it. slay.

πŸ’… DESCRIPTION πŸ’…

okay so what this does is: it sets the error description to the content of errstr. that's it, that's the job. πŸ’–

and here's the cute part β€” the string gets copied into the Shishi internal structure. so you can deallocate any string you passed to this function and it will not care. it already took what it needed. no cap, no dangling pointer drama, we love a clean copy. ✨

this function is mostly for Shishi's internal use, ngl. but if you're developing an extension of Shishi, it may genuinely be useful to support the same error handling infrastructure. like, same energy, same system. iykyk. πŸ”₯


😭 REPORTING BUGS 😭

found a bug? not you being the main character of QA πŸ’€ report bugs to <bug-shishi@gnu.org>.


Copyright Β© 2002-2022 Simon Josefsson.

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. iconic, honestly. πŸŽ€


πŸ¦‹ 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, the command

info shishi

should give you access to the complete manual. go read it, bestie, it's giving encyclopedia but make it shishi. 🌈


and that's the whole page!! this lil guy is from shishi version 1.0.3, and yeah, it's the shishi_error_set(3) page β€” mwah, periodt. πŸ’œβœ¨