1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
|
.TH al_ref_cstr 3 "" "Allegro reference manual"
.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[]
.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[C]info\f[]
parameter.
The string will not have any other storage allocated of its own, so if
you allocate the \f[C]info\f[] structure on the stack then no explicit
"free" 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,\ "my\ string");
\f[]
.fi
.SH SEE ALSO
.PP
al_ref_buffer(3), al_ref_ustr(3)
|
