shisa_init_with_paths(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

💖 shisa_init_with_paths — the "spin up a Shisa handle from a file" girlie 💖

okay bestie, so this one is a function from the shishi library, and it's literally the entry point that hands you a shiny Shisa handle while also letting you pick which config file it reads. yes ma'am. let's get into it. 🎀

✨ NAME ✨

shisa_init_with_paths — an API function, and she's the one who sets up your Shisa library handle with a config file path of your choosing 🦋

🌸 SYNOPSIS 🌸

#include <shisa.h>

int shisa_init_with_paths(Shisa ** dbh, const char * file);

💅 ARGUMENTS 💅

  • Shisa ** dbh — a returned pointer to a freshly created Shisa library handle. like, you pass in the address of your pointer and she fills it in for you. iconic behaviour honestly.
  • const char * file — the filename of the system configuration, or NULL. you can absolutely just pass NULL and let her do her thing, iykyk.

👑 DESCRIPTION 👑

So she creates a Shisa library handle — she's using shisa() under the hood — except she reads the system configuration file at the location you give her in file. 🫶

Not feeling the whole "specify a path" vibe? Pass NULL for file and she'll go to the default location instead. The path to that default system configuration file is decided at compile time, and it's literally this:

$sysconfdir/shisa.conf

now here's the part where you need to pay attention, bestie, because it's giving important: 🚨

The handle is allocated regardless of return value. The only exception is SHISA_INIT_ERROR, which means there was a problem allocating the handle. Any other error conditions come up while reading a file.

so yeah — she doesn't leave you hanging with a NULL handle just because something went sideways reading the file. the handle's there. the errors are separate. periodt. 💀✨

⭐ RETURN VALUE ⭐

Returns SHISA_OK, or an error code. And specifically, the value SHISA_INIT_ERROR means a failure to create the handle. that's the one you really don't want to see. 🙈

🍓 REPORTING BUGS 🍓

Found a bug? spill the tea 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. slay, and also legally binding. 💜

🧚 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. go read her, she's thorough. 📖✨

and that's the whole page, bestie!! this was shisa_init_with_paths(3) from shishi 1.0.3 — the manual name lives up at the top and the version is right here in the sign-off, because we do things properly in this group chat. 🎀💖🦋 mwah, go forth and init your handles. 👑

📦 where this page comes from