shishi_tkts_find(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_tkts_find(3) 💖

okay bestie, sit down, hydrate, and let me tell you about shishi_tkts_find — it's a lil function from the shishi manual (section 3, the library girlies) and she's here to hunt down tickets for you. no cap.

✨ NAME ✨

shishi_tkts_find — it's an API function, bestie. that's the whole vibe. 🎀

🌸 SYNOPSIS 🌸

#include <shishi.h>

Shishi_tkt * shishi_tkts_find(Shishi_tkts * tkts, Shishi_tkts_hint * hint);

look at her. two args, one dream. 💅

🦋 ARGUMENTS 🦋

  • Shishi_tkts * tkts — the ticket set handle, as allocated by shishi_tkts(). this is your lil basket of tickets, and yes you gotta have it first.
  • Shishi_tkts_hint * hint — a structure packed with the characteristics of the ticket you're tryna find. it's giving "search filter but make it a struct". ✨

👑 DESCRIPTION 👑

so here's the tea: this function searches the ticketset sequentially — like, from ticket number 0 through all the tickets in the set — looking for a ticket that fits the characteristics you handed over.

and the way that it's iconic?? if a ticket is found, the hint->startpos field gets updated to point to the next ticket in the set. which means you can call this function over and over again with the same hint argument and it'll keep finding all the tickets that match a certain criterium. literally a little iterator, she's so smart. 🧚

⚠️ but listen — if tickets get added to, or removed from, the ticketset while you're mid-query with the same hint argument, then the hint->startpos field must be updated appropriately. don't just let it drift, bestie, that's how you get lost in the set. 💀

💜 HERE IS HOW YOU WOULD TYPICALLY USE THIS FUNCTION 💜

okay so this is the whole ~moment~, look:

Shishi_tkts_hint  hint;

Shishi_tkt  tkt;

memset(&hint, 0, sizeof(hint));

hint.server = "imap/mail.example.org";

tkt = shishi_tkts_find (shishi_tkts_default(handle), &hint);

if (!tkt)

printf("No ticket found...0);

else

do_something_with_ticket (tkt);

(and yes, that printf line really is written like that in the original. we don't fix, we don't touch, we preserve. 🫶)

🌈 RETURN VALUE 🌈

returns a ticket if one's found — or NULL if no further matching tickets could be found. so like, NULL means the search said "sorry babe, nothing left". 😭

🔥 REPORTING BUGS 🔥

found a bug? don't gatekeep, 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.

⭐ 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. periodt. 💅

and that's the whole page, bestie — this was shishi_tkts_find(3) from shishi version 1.0.3, mwah, go find your tickets 🦋💖✨

📦 where this page comes from