al_fget_ustr(3alleg5)

al_fget_ustr3alleg5

Allegro 5 api

Usage

#include <allegro5/allegro.h>
ALLEGRO_USTR *al_fget_ustr(ALLEGRO_FILE *f)

Overview

Read a string of bytes terminated with a newline or end-of-file. The line terminator(s), if any, are included in the returned string.

On success returns a pointer to a new ALLEGRO_USTR structure. This must be freed eventually with al_ustr_free(3alleg5). Returns NULL if an error occurred or if the end of file was reached without reading any bytes.

See al_fopen(3alleg5) about translations of end-of-line characters.

Releases

6 releases since Debian 8 (Jessie); the text changed 5 times.

  1. 8
  2. 9
  3. 10
  4. 11
  5. 12
  6. 13

From allegro5-doc 2:5.2.10.1+dfsg-1 in Debian 13 (Trixie). Parsed by carta from the page's man source.