summary refs log tree commit diff
path: root/doc/zlib/gzeof.3
blob: 26c415febc3236deee178657c56b4232f6792663 (plain) (blame)
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
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
.Dd January 15, 2017
.Dt GZEOF 3
.Os
.
.Sh NAME
.Nm gzeof
.Nd check end-of-file indicator
.
.Sh LIBRARY
.Lb libz
.
.Sh SYNOPSIS
.In zlib.h
.Ft int
.Fn gzeof "gzFile file"
.
.Sh DESCRIPTION
Returns true (1)
if the end-of-file indicator
has been set while reading,
false (0) otherwise.
Note that the end-of-file indicator
is set only if the read
tried to go past the end of the input,
but came up short.
Therefore,
just like
.Xr feof 3 ,
.Fn gzeof
may return false
even if there is no more data to read,
in the event that the last read request
was for the exact number of bytes
remaining in the input file.
This will happen if the input file size
is an exact multiple of the buffer size.
.
.Pp
If
.Fn gzeof
returns true,
then the read functions
will return no more data,
unless the end-of-file indicator
is reset by
.Xr gzclearerr 3
and the input file
has grown since the previous
end of file was detected.
.
.Sh SEE ALSO
.Xr gzerror 3 ,
.Xr gzread 3
.
.Sh HISTORY
This manual page was converted from
.In zlib.h
to mdoc format by
.An C. McEnroe Aq Mt june@causal.agency .
.
.Sh AUTHORS
.An Jean-loup Gailly Aq Mt jloup@gzip.org
.An Mark Adler Aq Mt madler@alumni.caltech.edu