MRMFETCHICONLITERAL(3)

💖 MrmFetchIconLiteral — the library call that's literally serving icon literals 💅

ok bestie, gather round, because today we're talking about MrmFetchIconLiteral, a little library call from the Mrm family (you know, the Motif resource manager girlies) and she is so useful. Her whole job? Pull an icon literal out of an MRM hierarchy and turn it into an actual X pixmap. It's giving "glow up, but make it pixel data." ✨

---

🌸 NAME 🌸

MrmFetchIconLiteral — fetches an icon literal from a hierarchy. no cap, that's the entire vibe. 🎀

---

✨ SYNOPSIS ✨

#include <Mrm/MrmPublic.h>
Cardinal MrmFetchIconLiteral(
MrmHierarchy hierarchy_id,
String index,
Screen *screen,
Display *display,
Pixel fgpix,
Pixel bgpix,
Pixmap *pixmap);

yes she takes seven arguments. seven. she's high maintenance and she's worth it. 🫶

---

💜 DESCRIPTION 💜

The MrmFetchIconLiteral function fetches an icon literal from an MRM hierarchy and converts the icon literal to an X pixmap. that's the whole plot. that's the movie. 🍓

now let's meet the cast, one by one, because every single one of them matters:

• hierarchy_id — Specifies the ID of the UID hierarchy that contains the specified icon literal. And bestie, you can't just make this up — this hierarchy_id was returned in a previous call to MrmOpenHierarchyPerDisplay. so if you skipped that step, that's on you. 🙈
• index — Specifies the UIL name of the icon literal to fetch. it's the name, the lookup key, the "hey girl are you in there" of it all.
• screen — Specifies the screen used for the pixmap. The screen argument specifies a pointer to the Xlib structure Screen, which contains the information about that screen and is linked to the Display structure. want more lore on the Display and Screen structures? see the Xlib function XOpenDisplay and the associated screen information macros. iykyk. 🖥️
• display — Specifies the display used for the pixmap. The display argument specifies the connection to the X server. again, for more info on the Display structure, go look at the Xlib function XOpenDisplay. it's the group chat between you and the X server, fr fr.
• fgpix — Specifies the foreground color for the pixmap. your icon's main character color. 👑
• bgpix — Specifies the background color for the pixmap. the supporting role that makes the fg pop.
• pixmap — Returns the resulting X pixmap value. The function allocates space for this pixmap. The application is responsible for managing the allocated space. The application can recover the allocated space by calling XmDestroyPixmap. translation bestie: she hands you the keys, but YOU are driving. don't forget to clean up after yourself or the memory leak is gonna be your villain origin story. 😭💀

---

🔥 RETURN 🔥

This function returns one of the following status return constants. vibe check time:

• MrmSUCCESS — The function executed successfully. ate and left no crumbs. ✨
• MrmBAD_HIERARCHY — The hierarchy ID was invalid. that hierarchy is not who she said she was. 💀
• MrmNOT_FOUND — The icon literal was not found in the hierarchy. she's just not there, bestie. gone. not in this hierarchy. 😭
• MrmWRONG_TYPE — The caller tried to fetch a literal of a type not supported by this function. wrong function, wrong type, wrong era, respectfully. 🙈
• MrmFAILURE — The function failed. it's giving flop. it happens. 🫶

heads up: always check the return value before you start celebrating. MrmSUCCESS is the only one that means go off. everything else means debug era. 💅

---

🌈 RELATED 🌈

go read these next, they're the friend group:

• MrmFetchBitmapLiteral(3)
• MrmOpenHierarchyPerDisplay(3)
• MrmFetchLiteral(3)
• MrmFetchColorLiteral(3)
• XOpenDisplay(3)

---

and that's the whole page, bestie. this was MrmFetchIconLiteral(library call) — yes, that's both the title and the footer, she's consistent like that, no date drama, just pure library-call energy. now go fetch some icon literals and slay. 🧚💖✨