---
name: "al_ustr_encode_utf16"
section: "3alleg5"
platform: "linux"
package: "allegro5-doc"
version: "2:5.2.10.1+dfsg-1"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/al_ustr_encode_utf16/3alleg5"
---

# al\_ustr\_encode\_utf16(3alleg5)

Allegro 5 API

## NAME

al\_ustr\_encode\_utf16 - Allegro 5 API

## SYNOPSIS

-

  ```
  #include <allegro5/allegro.h>
  size_t al_ustr_encode_utf16(const ALLEGRO_USTR *us, uint16_t *s,
     size_t n)
  ```

## DESCRIPTION

Encode the string into the given buffer, in UTF-16. Returns the number of bytes written. There are never more than `n` bytes written. The minimum size to encode the complete string can be queried with al\_ustr\_size\_utf16(3alleg5). If the `n` parameter is smaller than that, the string will be truncated but still always 0 terminated.

## SEE ALSO

al\_ustr\_size\_utf16(3alleg5), al\_utf16\_encode(3alleg5)