.\" Automatically generated by Pandoc 3.6.1
.\"
.TH "al_ustr_encode_utf16" "3" "" "Allegro reference manual"
.SH NAME
al_ustr_encode_utf16 \- Allegro 5 API
.SH SYNOPSIS
.IP
.EX
#include \f[B]<allegro5/allegro.h>\f[R]

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