File: al_fread.3

package info (click to toggle)
allegro5 2%3A5.0.10-3
  • links: PTS, VCS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 14,856 kB
  • ctags: 15,948
  • sloc: ansic: 87,540; cpp: 9,693; objc: 3,491; python: 2,057; sh: 829; makefile: 93; perl: 37; pascal: 24
file content (28 lines) | stat: -rw-r--r-- 701 bytes parent folder | download
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
28
.TH al_fread 3 "" "Allegro reference manual"
.SH NAME
.PP
al_fread \- Allegro 5 API
.SH SYNOPSIS
.IP
.nf
\f[C]
#include\ <allegro5/allegro.h>

size_t\ al_fread(ALLEGRO_FILE\ *f,\ void\ *ptr,\ size_t\ size)
\f[]
.fi
.SH DESCRIPTION
.PP
Read \[aq]size\[aq] bytes into the buffer pointed to by \[aq]ptr\[aq],
from the given file.
.PP
Returns the number of bytes actually read.
If an error occurs, or the end\-of\-file is reached, the return value is
a short byte count (or zero).
.PP
al_fread() does not distinguish between EOF and other errors.
Use al_feof(3) and al_ferror(3) to determine which occurred.
.SH SEE ALSO
.PP
al_fgetc(3), al_fread16be(3), al_fread16le(3), al_fread32be(3),
al_fread32le(3)