File: al_ustr_get_next.3

package info (click to toggle)
allegro5 2%3A5.0.10-3
  • links: PTS, VCS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 14,856 kB
  • ctags: 15,948
  • sloc: ansic: 87,540; cpp: 9,693; objc: 3,491; python: 2,057; sh: 829; makefile: 93; perl: 37; pascal: 24
file content (27 lines) | stat: -rw-r--r-- 681 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
.TH al_ustr_get_next 3 "" "Allegro reference manual"
.SH NAME
.PP
al_ustr_get_next \- Allegro 5 API
.SH SYNOPSIS
.IP
.nf
\f[C]
#include\ <allegro5/allegro.h>

int32_t\ al_ustr_get_next(const\ ALLEGRO_USTR\ *us,\ int\ *pos)
\f[]
.fi
.SH DESCRIPTION
.PP
Find the code point in \f[C]us\f[] beginning at byte offset
\f[C]*pos\f[], then advance to the next code point.
.PP
On success return the code point value.
If \f[C]pos\f[] was out of bounds (e.g.
past the end of the string), return \-1.
On an error, such as an invalid byte sequence, return \-2.
As with al_ustr_next(3), invalid byte sequences may be skipped while
advancing.
.SH SEE ALSO
.PP
al_ustr_get(3), al_ustr_prev_get(3)