RKINITIALIZE(3)

💖 RKINITIALIZE(3) 💖

okay bestie, welcome to the Library Functions Manual — this is the page for RkInitialize, and it's literally the initialize the kana-kanji conversion functions girlie. she's the one who wakes everything up. the main character of setup. periodt.

✨ SYNOPSIS ✨

#include <canna/RK.h>
int RkInitialize(dhdpath)
char *dhdpath;

like, that's the whole entrance. she takes one arg and she takes it seriously 🫶

🌸 DESCRIPTION 🌸

RkInitialize initiates the kana-kanji conversion functions. that's her whole job and she ate. and what's dhdpath, you ask? it names the dictionary home directory. so you gotta tell her where the dictionary lives, no cap. 📚✨

so here's the lore: because this library permits multiple kana-kanji conversions to proceed concurrently, it uses the conversion context method of control to manage all the kana-kanji conversions. think of each context as its own little vibe bubble — it contains internal data needed to perform a kana-kanji conversion. every bubble got its own stuff inside it. iconic. 🫧

and how do you tell the bubbles apart? context numbers, duh. users identify the conversion contexts from one another by their context number. a context number is an integer of 0 or greater, and it's used as the first parameter of the kana-kanji conversion function. so like, the number is the name tag. iykyk. 🏷️

now the important part, don't skip this: right after the kana-kanji conversion functions are initialized by RkInitialize, only the standard context with context number 0 exists. just the one. context number 0. that's it. and applications using only one context can use the standard context — so if you're a one-context kind of app, you're already covered, bestie, you don't gotta do anything extra. 👑

🎀 RETURN VALUE 🎀

• this function returns 0 if successful 💚
• otherwise, it returns -1 💀

so like, check the return value. -1 is not a vibe.

🦋 SEE ALSO 🦋

• RkFinalize(3) — the cleanup counterpart, she closes what this one opens 💅

and that's the page!! RKINITIALIZE(3), straight out of the Library Functions Manual, no date on this footer so we're just vibing with the page name and honestly? timeless. slay. go initialize something. 🍓🧚💜