.\" Automatically generated by Pandoc 3.1.3
.\"
.\" Define V font for inline verbatim, using C font in formats
.\" that render this, and otherwise B font.
.ie "\f[CB]x\f[]"x" \{\
. ftr V B
. ftr VI BI
. ftr VB B
. ftr VBI BI
.\}
.el \{\
. ftr V CR
. ftr VI CI
. ftr VB CB
. ftr VBI CBI
.\}
.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[R]
.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[V]n\f[R] bytes written.
The minimum size to encode the complete string can be queried with
al_ustr_size_utf16(3alleg5).
If the \f[V]n\f[R] 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)