.\" Automatically generated by Pandoc 3.1.3
.\"
.\" Define V font for inline verbatim, using C font in formats
.\" that render this, and otherwise B font.
.ie "\f[CB]x\f[]"x" \{\
. ftr V B
. ftr VI BI
. ftr VB B
. ftr VBI BI
.\}
.el \{\
. ftr V CR
. ftr VI CI
. ftr VB CB
. ftr VBI CBI
.\}
.TH "al_fgets" "3alleg5" "" "Allegro reference manual" ""
.hy
.SH NAME
.PP
al_fgets - Allegro 5 API
.SH SYNOPSIS
.IP
.nf
\f[C]
#include <allegro5/allegro.h>

char *al_fgets(ALLEGRO_FILE *f, char * const buf, size_t max)
\f[R]
.fi
.SH DESCRIPTION
.PP
Read a string of bytes terminated with a newline or end-of-file into the
buffer given.
The line terminator(s), if any, are included in the returned string.
A maximum of max-1 bytes are read, with one byte being reserved for a
NUL terminator.
.PP
Parameters:
.IP \[bu] 2
f - file to read from
.IP \[bu] 2
buf - buffer to fill
.IP \[bu] 2
max - maximum size of buffer
.PP
Returns the pointer to buf on success.
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_fget_ustr(3alleg5)