File: al_ustr_next.3

package info (click to toggle)
allegro5 2%3A5.2.2-1
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 23,032 kB
  • sloc: ansic: 120,340; cpp: 15,707; objc: 4,805; python: 2,915; java: 2,195; sh: 887; xml: 86; makefile: 49; perl: 37; pascal: 24
file content (31 lines) | stat: -rw-r--r-- 878 bytes parent folder | download
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
.TH "al_ustr_next" "3" "" "Allegro reference manual" ""
.SH NAME
.PP
al_ustr_next \- Allegro 5 API
.SH SYNOPSIS
.IP
.nf
\f[C]
#include\ <allegro5/allegro.h>

bool\ al_ustr_next(const\ ALLEGRO_USTR\ *us,\ int\ *pos)
\f[]
.fi
.SH DESCRIPTION
.PP
Find the byte offset of the next code point in string, beginning at
\f[C]*pos\f[].
\f[C]*pos\f[] does not have to be at the beginning of a code point.
.PP
Returns true on success, and the value pointed to by \f[C]pos\f[] will
be updated to the found offset.
Otherwise returns false if \f[C]*pos\f[] was already at the end of the
string, and \f[C]*pos\f[] is unmodified.
.PP
This function just looks for an appropriate byte; it doesn\[aq]t check
if found offset is the beginning of a valid code point.
If you are working with possibly invalid UTF\-8 strings then it could
skip over some invalid bytes.
.SH SEE ALSO
.PP
al_ustr_prev(3)