XMFONTLISTENTRYLOAD(3)

💖 NAME 💖

XmFontListEntryLoad — bestie, this is a font list function that loads a font or creates a font set, and then creates an accompanying font list entry to go with it. It's giving matchmaker for fonts and font lists, fr fr 🫶

---

🎀 SYNOPSIS 🎀

#include <Xm/Xm.h>
XmFontListEntry XmFontListEntryLoad(
Display *display,
char *font_name,
XmFontType type,
char *tag);

---

✨ DESCRIPTION ✨

Okay so here's the vibe: XmFontListEntryLoad loads a font or creates a font set, and which one it does depends entirely on the value of the type argument. Then it creates and returns a font list entry that holds the font or font set plus the tag you gave it. Iconic behavior, no notes 💅

If the value of type is XmFONT_IS_FONT, the function uses the XtCvtStringToFontStruct routine to convert the value of font_name into a font struct. If the value of type is XmFONT_IS_FONTSET, the function uses the XtCvtStringToFontSet converter to create a font set in the current locale. Either way, XmFontListEntryLoad creates a font list entry containing the font or font set that came out of the converter. For more info about XtCvtStringToFontStruct and XtCvtStringToFontSet, go read X Toolkit Intrinsics—C Language Interface. It's the required reading, sorry bestie 😭

• display — specifies the display where the font list will be used. 🖥️
• font_name — specifies an X Logical Font Description (XLFD) string, which gets interpreted either as a font name or as a base font name list. Heads up: a base font name list is a comma-separated and NULL-terminated string. Commas AND a NULL terminator, don't forget the second one 🌸
• type — specifies whether the font_name argument refers to a font name or to a base font name list. Valid values are XmFONT_IS_FONT and XmFONT_IS_FONTSET. Only those two, no free styling 👑
• tag — specifies the tag of the font list entry to be created. You may specify it as XmFONTLIST_DEFAULT_TAG, which is what gets used to identify the default font list element in a font list when it's specified as part of a resource. Default-tag energy, we love to see it ✨

---

🔥 RETURN 🔥

Here's where it gets real, so pay attention:

If the specified font is not found, or if the specified font set cannot be created, then either an implementation-defined font will be opened or a font set will be created, and a warning message will be generated. Not a drill, just a heads-up 💀

And if no suitable font can be found or a font set cannot be created, then another message gets generated and the function will return NULL. That's the sad ending. 😭

Otherwise? The function returns a font list entry. 🎉

And if it does return a font list entry, bestie, listen: the function allocates space to hold that font list entry. The application is responsible for managing the allocated space. That's on you, not on it. The application can recover the allocated space by calling XmFontListEntryFree. Free your memory, queen 🧚

---

🌈 RELATED 🌈

XmFontList(3), XmFontListAppendEntry(3), XmFontListEntryCreate(3), XmFontListEntryFree(3), XmFontListEntryGetFont(3), XmFontListEntryGetTag(3), and XmFontListRemoveEntry(3).

Go read those too, iykyk 📚

---

And that's the whole page, bestie — straight from the XmFontListEntryLoad(library call) manual, the one and only. It's a library call page, so treat it with the respect of a library call page. Now go load some fonts and slay 💖✨🎀