al_ref_cstr(3)

💅 al_ref_cstr(3) 💅

okay bestie, welcome to the Library Functions Manual — today's main character is al_ref_cstr(3) from the Allegro 5 API, and she's here to let a string vibe off C-string storage. no cap.

✨ NAME ✨

• al_ref_cstr — Allegro 5 API (short, sweet, iconic)

🎀 SYNOPSIS 🎀

#include <allegro5/allegro.h>

const ALLEGRO_USTR *al_ref_cstr(ALLEGRO_USTR_INFO *info, const char *s)

🦋 DESCRIPTION 🦋

so basically this function creates a string that references the storage of a C-style string. it is not out here allocating a whole new copy of the string's storage — it references the storage, periodt.

the information about the string (like its size, iykyk) is stored in the structure pointed to by the info parameter.

the string will not have any other storage allocated of its own, so if you allocate the info structure on the stack then no explicit free operation is required. stack info, no manual free — lowkey a slay.

🚨 vibe check: the string is valid until the underlying C string disappears. after that? it's a no-go, bestie. don't keep using the reference once the C string has ghosted.

Example, because examples ate:

ALLEGRO_USTR_INFO info;
ALLEGRO_USTR *us = al_ref_cstr(&info, "my string");

🌈 SEE ALSO 🌈

• al_ref_buffer(3) — go look at this sibling
• al_ref_ustr(3) — and this one too, fr fr

---

Signed, sealed, and sent with sparkles from the Allegro reference manual — no date stamped on this one, so we're just gonna call it undated and iconic 💌