RKGETYOMI(3)

💖 NAME 💖

RkGetYomi — bestie, this is the function that pulls up the reading of the current clause. That's it. That's the whole job. 👑

✨ SYNOPSIS ✨

#include <canna/RK.h>
int RkGetYomi(cxnum, yomi, maxyomi)
int cxnum;
unsigned char *yomi;
int maxyomi;

okay so the vibe is: three args, one int coming back, and a header you gotta include or nothing works. 🦋

🌸 DESCRIPTION 🌸

So like, RkGetYomi grabs the reading of the current clause and drops it right into the area called yomi. 🌈

And here's the one lil thing you need to know, no cap: the resulting character string gets truncated when its byte length exceeds maxyomi -1. So maxyomi is your budget and that -1 is already spent — plan accordingly, gorgeous. 💅

🎀 RETURN VALUE 🎀

This function returns the length of the reading of the current clause. Slay. ✨

But if it's been run in a nonconversion mode context, it returns -1, and it does not do anything. Like, zero. Nothing. Not a single byte. 🫶

bestie pls check your mode before you call this, because a silent -1 is giving "left on read" energy 😭

and that's the whole page fr fr. this little manual lives in the Library Functions Manual, section 3, and it goes by RKGETYOMI(3) — that's the name at the top and the name at the bottom, iconic bookends honestly. mwah, go read some yomi 💖🎀🦋