.\" Automatically generated by Pandoc 2.2.1
.\"
.TH "al_ustr_encode_utf16" "3alleg5" "" "Allegro reference manual" ""
.hy
.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(3alleg5).
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(3alleg5), al_utf16_encode(3alleg5)