.\" Automatically generated by Pandoc 2.2.1
.\"
.TH "al_fget_ustr" "3alleg5" "" "Allegro reference manual" ""
.hy
.SH NAME
.PP
al_fget_ustr \- Allegro 5 API
.SH SYNOPSIS
.IP
.nf
\f[C]
#include\ <allegro5/allegro.h>

ALLEGRO_USTR\ *al_fget_ustr(ALLEGRO_FILE\ *f)
\f[]
.fi
.SH DESCRIPTION
.PP
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.
.PP
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.
.PP
See al_fopen(3alleg5) about translations of end\-of\-line characters.
.SH SEE ALSO
.PP
al_fgetc(3alleg5), al_fgets(3alleg5)