.\" Automatically generated by Pandoc 3.1.3
.\"
.\" Define V font for inline verbatim, using C font in formats
.\" that render this, and otherwise B font.
.ie "\f[CB]x\f[]"x" \{\
. ftr V B
. ftr VI BI
. ftr VB B
. ftr VBI BI
.\}
.el \{\
. ftr V CR
. ftr VI CI
. ftr VB CB
. ftr VBI CBI
.\}
.TH "al_ref_cstr" "3alleg5" "" "Allegro reference manual" ""
.hy
.SH NAME
.PP
al_ref_cstr - Allegro 5 API
.SH SYNOPSIS
.IP
.nf
\f[C]
#include <allegro5/allegro.h>

const ALLEGRO_USTR *al_ref_cstr(ALLEGRO_USTR_INFO *info, const char *s)
\f[R]
.fi
.SH DESCRIPTION
.PP
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[V]info\f[R] parameter.
The string will not have any other storage allocated of its own, so if
you allocate the \f[V]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
.nf
\f[C]
ALLEGRO_USTR_INFO info;
ALLEGRO_USTR *us = al_ref_cstr(&info, \[dq]my string\[dq]);
\f[R]
.fi
.SH SEE ALSO
.PP
al_ref_buffer(3alleg5), al_ref_ustr(3alleg5)