File: al_ustr_get.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 (25 lines) | stat: -rw-r--r-- 562 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
.TH "al_ustr_get" "3" "" "Allegro reference manual" ""
.SH NAME
.PP
al_ustr_get \- Allegro 5 API
.SH SYNOPSIS
.IP
.nf
\f[C]
#include\ <allegro5/allegro.h>

int32_t\ al_ustr_get(const\ ALLEGRO_USTR\ *ub,\ int\ pos)
\f[]
.fi
.SH DESCRIPTION
.PP
Return the code point in \f[C]ub\f[] beginning at byte offset
\f[C]pos\f[].
.PP
On success returns 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.
.SH SEE ALSO
.PP
al_ustr_get_next(3), al_ustr_prev_get(3)