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_ustr 3 "" "Allegro reference manual"
.SH NAME
.PP
al_ref_ustr \- Allegro 5 API
.SH SYNOPSIS
.IP
.nf
\f[C]
#include\ <allegro5/allegro.h>
const\ ALLEGRO_USTR\ *al_ref_ustr(ALLEGRO_USTR_INFO\ *info,\ const\ ALLEGRO_USTR\ *us,
\ \ \ int\ start_pos,\ int\ end_pos)
\f[]
.fi
.SH DESCRIPTION
.PP
Create a read\-only string that references the storage of another
ALLEGRO_USTR(3) 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 new 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 referenced interval is [start_pos, end_pos).
Both are byte offsets.
.PP
The string is valid until the underlying string is modified or
destroyed.
.PP
If you need a range of code\-points instead of bytes, use
al_ustr_offset(3) to find the byte offsets.
.SH SEE ALSO
.PP
al_ref_cstr(3), al_ref_buffer(3)
|
