MRMFETCHCOLORLITERAL(3)

💅 NAME 💅

MrmFetchColorLiteral — bestie, this function fetches a named color literal out of a UID file. That's the whole job. She's a fetch girlie. 🎀

---

✨ SYNOPSIS ✨

#include <Mrm/MrmPublic.h>
Cardinal MrmFetchColorLiteral(
MrmHierarchy hierarchy_id,
String index,
Display *display,
Colormap colormap_id,
Pixel *pixel);

---

🦋 DESCRIPTION 🦋

Okay so the MrmFetchColorLiteral function fetches a named color literal from a UID file, and converts the color literal to a pixel color value. Two steps, zero drama, she ate. 💖

Now the arguments, one by one, no skipping, periodt:

• hierarchy_id — the ID of the UID hierarchy that contains the literal you're after. You got this value from an earlier call to MrmOpenHierarchyPerDisplay, so like… she remembers you from last time. 🫶
• index — the UIL name of the color literal you wanna fetch. Heads up bestie: you must define this name in UIL as an exported value, or it's giving nothing. ✨
• display — the display used for the pixmap. This arg specifies the connection to the X server. For more info on the Display structure, go see the Xlib function XOpenDisplay. iykyk 💅
• colormap_id — the ID of the color map. And if colormap_id is NULL, the default color map gets used instead. lowkey convenient. 🌈
• pixel — this one returns the ID of the color literal. She gives back. 👑

---

🔥 RETURN 🔥

This function returns one of the following status return constants, and you should actually check which one, no cap:

• MrmSUCCESS — the function executed successfully. slay!! 🎉
• MrmBAD_HIERARCHY — the hierarchy ID was invalid. not the hierarchy ID being fake 😭
• MrmNOT_FOUND — the color literal was not found in the UIL file. she's not there, bestie. 💀
• MrmWRONG_TYPE — the caller tried to fetch a literal of a type not supported by this function. wrong vibe, wrong type, we don't do that here. 🙈
• MrmFAILURE — the function failed. it's giving failure. that's it, that's the whole constant. 💔

---

🌸 RELATED 🌸

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

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

---

and that's the whole page, bestie 💜 this one's filed under MrmFetchColorLiteral(library call) — no date on it, she's timeless like that ✨ go fetch ur color literal and be iconic 👑💖