shishi_key_from_value(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_key_from_value — the manual page, but make it make sense 💖

okay bestie, so this is shishi_key_from_value(3), living in the shishi manual section. it's an API function and honestly? it's giving "i make keys out of thin air" and i'm obsessed. 🎀

✨ SYNOPSIS ✨

#include <shishi.h>

int shishi_key_from_value(Shishi * handle, int32_t type, const char *
value, Shishi_key ** key);

like… four things in, one int out. slay. 💅

🌸 ARGUMENTS 🌸

  • Shishi * handle — the Shishi library handle, the one you made with shishi_init(). it's literally the whole vibe of your session, don't lose it 🫶
  • int32_t type — the type of key. that's it, that's the whole description, periodt.
  • const char * value — an input array holding the key value, or NULL if you simply don't have one. no key value? valid. iconic, even.
  • Shishi_key ** key — a pointer to the structure that's gonna hold the newly created key information. she's a double pointer because she's that girl 👑

💜 DESCRIPTION 💜

so the whole plot: you call this, and it creates a brand new Key information structure, then sets the key type and the key value on it. two for one, we love efficiency. ✨

heads up bestie — KEY contains a newly allocated structure only if this function is successful. no success, no allocation. the way that matters 😭

⭐ RETURN VALUE ⭐

returns SHISHI_OK iff successful. that's the only good outcome and she knows it. anything else is not the moment. 💀

🦋 REPORTING BUGS 🦋

found a bug? (not me manifesting it 🙈) report it 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. fr fr, that's the whole license vibe. 🎀

🌈 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 main character energy 📚✨

and that's the whole page 💖 — this was shishi_key_from_value(3) from shishi 1.0.3, brought to you straight from the manual. bye bestie, go make some keys 🫶

📦 where this page comes from