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

int\ al_ustr_offset(const\ ALLEGRO_USTR\ *us,\ int\ index)
\f[]
.fi
.SH DESCRIPTION
.PP
Return the byte offset (from the start of the string) of the code point
at the specified index in the string.
A zero index parameter will return the first character of the string.
If index is negative, it counts backward from the end of the string, so
an index of \-1 will return an offset to the last code point.
.PP
If the index is past the end of the string, returns the offset of the
end of the string.
.SH SEE ALSO
.PP
al_ustr_length(3)