1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
|
.TH "al_fget_ustr" "3" "" "Allegro reference manual" ""
.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(3).
Returns NULL if an error occurred or if the end of file was reached
without reading any bytes.
.PP
See al_fopen(3) about translations of end\-of\-line characters.
.SH SEE ALSO
.PP
al_fgetc(3), al_fgets(3)
|
