File: al_ustr_encode_utf16.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-- 684 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_encode_utf16 3 "" "Allegro reference manual"
.SH NAME
.PP
al_ustr_encode_utf16 \- Allegro 5 API
.SH SYNOPSIS
.IP
.nf
\f[C]
#include\ <allegro5/allegro.h>

size_t\ al_ustr_encode_utf16(const\ ALLEGRO_USTR\ *us,\ uint16_t\ *s,
\ \ \ size_t\ n)
\f[]
.fi
.SH DESCRIPTION
.PP
Encode the string into the given buffer, in UTF\-16.
Returns the number of bytes written.
There are never more than \f[C]n\f[] bytes written.
The minimum size to encode the complete string can be queried with
al_ustr_size_utf16(3).
If the \f[C]n\f[] parameter is smaller than that, the string will be
truncated but still always 0 terminated.
.SH SEE ALSO
.PP
al_ustr_size_utf16(3), al_utf16_encode(3)