.\" Automatically generated by Pandoc 3.6.1
.\"
.TH "al_ref_cstr" "3" "" "Allegro reference manual"
.SH NAME
al_ref_cstr \- Allegro 5 API
.SH SYNOPSIS
.IP
.EX
#include \f[B]<allegro5/allegro.h>\f[R]

const ALLEGRO_USTR *al_ref_cstr(ALLEGRO_USTR_INFO *info, const char *s)
.EE
.SH DESCRIPTION
Create a string that references the storage of a C\-style string.
The information about the string (e.g.\ its size) is stored in the
structure pointed to by the \f[CR]info\f[R] parameter.
The string will not have any other storage allocated of its own, so if
you allocate the \f[CR]info\f[R] structure on the stack then no explicit
\[lq]free\[rq] operation is required.
.PP
The string is valid until the underlying C string disappears.
.PP
Example:
.IP
.EX
ALLEGRO_USTR_INFO info;
ALLEGRO_USTR *us = al_ref_cstr(&info, \[dq]my string\[dq]);
.EE
.SH SEE ALSO
al_ref_buffer(3), al_ref_ustr(3)