XMIMMBLOOKUPSTRING(3)

✨ XmImMbLookupString ✨

okay bestie, welcome to the library call manual page for XmImMbLookupString 💖 — she's an input manager function that pulls a composed string out of an input method, and honestly? she's doing the most and we love her for it 🫶

---

🌸 NAME 🌸

XmImMbLookupString — an input manager function that retrieves a composed string from an input method 💅

---

🎀 SYNOPSIS 🎀

#include <Xm/XmIm.h>
int XmImMbLookupString(
Widget widget,
XKeyPressedEvent *event,
char *buffer_return,
int bytes_buffer,
KeySym *keysym_return,
int *status_return);

---

🦋 DESCRIPTION 🦋

So here's the tea ☕ — XmImMbLookupString hands you back a string that got composed in the locale associated with the widget's input method, plus a KeySym that's currently mapped to the keycode in a KeyPress event. And where does that KeySym come from, you ask? The standard interpretation of Shift, Lock and Group modifiers, exactly as defined in the X Protocol specification. no cap, that's literally the spec 📜

not me having to tell you this part: an XIM will be created, but an XIC will NOT be created 😭. So one of these three functions — XmImSetValues, XmImVaSetValues, or XmImGetXIC — needs to be called to create an XIC. don't skip this step bestie, it's giving required 💀

Here's the squad of arguments, one by one:

• widget — specifies the ID of the widget registered with the input manager 👑
• event — specifies the key press event ⌨️
• buffer_return — specifies the buffer in which the string is returned 📥
• bytes_buffer — specifies the size of the buffer in bytes 📏
• keysym_return — specifies a pointer to the KeySym returned if one exists 🔑
• status_return — specifies the status values returned by the function. These status values are the same as those for the XmbLookupString function ✨

And the possible status values are… (drumroll 🥁):

• XBufferOverflow — the size of the buffer was insufficient to handle the returned string 😱. The contents of buffer_return and keysym_return are not modified. The required buffer size is returned as a value of the function. The client should repeat the call with a larger buffer size to receive the string. (like, just get a bigger buffer, it's fine 🫶)
• XLookupNone — no consistent input was composed 🙈. The contents of buffer_return and keysym_return are not modified and the function returns a value of 0.
• XLookupChars — some input characters were composed and returned in buffer_return 💖. The content of keysym_return is not modified. The function returns the length of the string in bytes.
• XLookupKeysym — a keysym value was returned instead of a string 🔑. The content of buffer_return is not modified and the function returns a value of 0.
• XLookupBoth — a keysym value and a string were returned 🌈. The keysym value may not necessarily correspond to the string returned (iykyk 👀). The function returns the length of the string in bytes.

---

💜 RETURN 💜

Return values depend on the status returned by the function, bestie. Refer to the description of status values above ⬆️ — they're all up there, go look 👑

---

⭐ RELATED ⭐

The whole friend group 🫂:

• XmImGetXIM(3)
• XmImGetXIC(3)
• XmImRegister(3)
• XmImSetValues(3)
• XmImUnregister(3)

---

and that's the whole page, periodt 💅✨ this one lives in the library call manual, signed off as XmImMbLookupString(library call) — mwah, take care of her 🎀🦋