shishi_keys_nth(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_keys_nth(3) 💖

okay bestie, welcome to the shishi section 3 manual, the one and only. this page is about shishi_keys_nth — it's giving "grab one specific key out of the pile" energy and honestly? iconic.

✨ NAME ✨

shishi_keys_nth — API function 🎀

🌸 SYNOPSIS 🌸

#include <shishi.h>

const Shishi_key * shishi_keys_nth(Shishi_keys * keys, int keyno);

🦋 ARGUMENTS 🦋

  • Shishi_keys * keys — the key set handle, aka the lil bundle you got from shishi_keys(). bestie, it has to be allocated first, no cap.
  • int keyno — an integer saying which key in the key set you're asking for. the vibes must be specific.

👑 GET THE N-th TICKET IN KEY SET 👑

(yes that's literally the section name, and yes it's a little mysterious, and yes we love that for it)

💅 RETURN VALUE 💅

Returns a key handle pointing at the keyno:th key in the key set. slay.

But listen — it returns NULL if keys is invalid or if keyno is out of bounds. 🫠 so do the vibe check, okay?

And the counting is zero-indexed, fr fr:

  • the first key is keyno 0
  • the second key is keyno 1
  • and so on, forever and ever, amen ✨
⚠️ don't forget: if keyno doesn't exist, you get NULL back, not a crash, not a key, just a sad little NULL. handle it. 😭

🙈 REPORTING BUGS 🙈

found a bug? spill the tea to <bug-shishi@gnu.org>. they want to know. 🐛

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. that's the license, bestie, we keep it exactly as it is — no edits, no erasing, periodt.

⭐ 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, it's the main character of documentation. 📚✨

and that's the whole page!! 🎀 this was the shishi manual, version 1.0.3, and we're signing off from shishi_keys_nth(3) — stay indexed, stay iconic, love u bye 💖🧚🌸

📦 where this page comes from