al_get_clipboard_text(3alleg5)

✨ NAME ✨

al_get_clipboard_text — the Allegro 5 API function that goes and grabs whatever text the clipboard is holding for you, bestie 💖

---

🌸 SYNOPSIS 🌸

#include <allegro5/allegro.h>

char *al_get_clipboard_text(ALLEGRO_DISPLAY *display)

---

🎀 DESCRIPTION 🎀

Okay so picture this: the clipboard has text, and you want it. That's literally the whole plot. This function returns a pointer to a string, and that string was allocated with al_malloc(3alleg5), and it contains the text contents of the clipboard — if available. That "if available" is doing a lot of work, so listen up.

If there's no text available on the clipboard, then this function returns NULL. No text, no pointer, no drama, that's it. 🙈

And the part everyone forgets: you must call al_free(3alleg5) on the returned pointer when you don't need it anymore. The memory is yours now, babes, nobody's gonna clean it up for you. Free your stuff. It's giving responsible main character energy 👑

⚠️ Beware bestie, for real: text on the clipboard on Windows may be in Windows format. That means it may have carriage return newline combinations for the line endings instead of regular newlines for the line endings on Linux or OSX. So if your line endings look cursed, that's why. Not you. Windows. 💀

---

🦋 SINCE 🦋

5.1.12 — she's been here since 5.1.12 and she's been slaying ever since ✨

---

🌈 SEE ALSO 🌈

• al_set_clipboard_text(3alleg5) — the reverse vibe, putting text onto the clipboard 🫶
• al_clipboard_has_text(3alleg5) — the vibe check, to see if there's anything there before you go grabbing 💅

---

And that's the page, bestie! This was the Allegro reference manual's al_get_clipboard_text(3alleg5) entry. Go forth, grab that clipboard text, free that pointer, and remember: carriage returns are a Windows thing and they're not your fault. Periodt. 🎀⭐