XrmEnumerateDatabase(3)

✨ XrmEnumerateDatabase — the one where we go shopping for resources 💅

okay so bestie, this is a page from XLIB FUNCTIONS and it's literally called XrmEnumerateDatabase 💖

---

🌸 NAME 🌸

XrmEnumerateDatabase — enumerate resource database entries. yes girl, it's the "walk through the whole database and show me what matches" function, no cap 🔥

---

🎀 SYNTAX 🎀

#include <X11/Xresource.h>
       #define   XrmEnumAllLevels       0
       #define   XrmEnumOneLevel        1

Bool XrmEnumerateDatabase(XrmDatabase database, XrmNameList name_prefix,
       XrmClassList class_prefix, int mode, Bool (*proc)(), XPointer
       arg);

those two #defines are the whole personality of the mode argument, iykyk 🦋 — XrmEnumAllLevels is 0 and XrmEnumOneLevel is 1, and like, remember them because you're gonna need them.

---

🦋 ARGUMENTS 🦋

• database — the resource database. like, the actual thing you're digging through 🗂️
• name_prefix — the resource name prefix. your starting point, bestie ✨
• class_prefix — the resource class prefix. the classy counterpart to the name prefix 👑
• mode — how many levels deep you wanna enumerate, aka your XrmEnumOneLevel vs XrmEnumAllLevels moment 💅
• proc — the procedure that gets called for each matching entry. your little callback bestie that does the actual work 🫶
• arg — the user-supplied argument that gets passed straight through to the procedure. a little gift for your callback 🎁

---

💖 DESCRIPTION 💖

so here's the tea ☕ — XrmEnumerateDatabase calls the specified procedure for each resource in the database that would match some completion of the given name/class resource prefix. it's giving "scavenger hunt but the prizes are resource entries" 🔍✨

the order in which resources are found is implementation-dependent, so like... don't come for me about the order, okay? it's not defined and that's just how it is 🙈

mode check, bestie:

• if mode is XrmEnumOneLevel, a resource must match the given name/class prefix with just a single name and class appended. one and done, no extra layers 💅
• if mode is XrmEnumAllLevels, the resource must match the given name/class prefix with one or more names and classes appended. go as deep as you want, we love a deep dive 🌊

and the stopping condition? flawless logic honestly:

• if the procedure returns True, the enumeration terminates and the function returns True 🛑✅
• if the procedure always returns False, all matching resources get enumerated and the function returns False 🏁❌

---

🧚 how the procedure gets called

the procedure is called with these exact arguments, and yes I'm putting the whole signature because it's important:

(*proc)(database, bindings, quarks, type, value, arg)
        XrmDatabase *database;
        XrmBindingList bindings;
        XrmQuarkList quarks;
        XrmRepresentation *type;
        XrmValue *value;
        XPointer arg;

the bindings and quarks lists are terminated by NULLQUARK — that's your sentinel, that's your "we're done here" marker 🎀

not me reminding you that pointers to the database and type are passed, but these values should not be modified 😭 like please do not touch, look respectfully only. 🙏

---

⚠️ RULES, bestie, listen up: the procedure must not modify the database. that's a hard no 🚫

and here's the spicy caveat 🌶️ — if Xlib has been initialized for threads, the procedure is called with the database locked, and the result of a call by the procedure to any Xlib function using the same database is not defined. yes, not defined, like, undefined-behavior kind of not defined 💀 so maybe don't do that!!

---

🌈 SEE ALSO 🌈

• XrmGetResource(3)
• XrmInitialize(3)
• XrmPutResource(3)
• Xlib - C Language X Interface

---

okay that's the whole page, you ate that 💅✨ X Version 11, libX11 1.8.14 — go forth and enumerate your resources, queen 👑🦋🍓