blob: 13dcddd4d3258fec62dfc0a0d535dffa59cef2a4 (
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
64
65
66
67
68
69
70
71
72
73
74
75
|
.Dd January 15, 2017
.Dt GZERROR 3
.Os
.
.Sh NAME
.Nm gzerror ,
.Nm gzclearerr
.Nd check and reset compressed file error
.
.Sh LIBRARY
.Lb libz
.
.Sh SYNOPSIS
.In zlib.h
.Ft const char *
.Fn gzerror "gzFile file" "int *errnum"
.Ft void
.Fn gzclearerr "gzFile file"
.
.Sh DESCRIPTION
.Fn gzerror
returns the error message for the last error
which occured on the given compressed file.
.Fa errnum
is set to the zlib error number.
If an error occurred in the file system
and not in the compression library,
.Fa errnum
is set to
.Dv Z_ERRNO
and the application may consult
.Va errno
to get the exact error code.
.
.Pp
The application must not modify the returned string.
Future calls to this function
may invalidate the previously returned string.
If
.Fa file
is closed,
then the string previously returned by
.Fn gzerror
will no longer be available.
.
.Pp
.Fn gzerror
should be used to distinguish errors from end-of-file
for those functions that do not distinguish those cases
in their return values.
.
.Pp
.Fn gzclearerr
clears the error and end-of-file for
.Fa file .
This is analogous to the
.Xr clearerr 3
function in stdio.
This is useful for continuing to read a gzip file
that is being written concurrently.
.
.Sh SEE ALSO
.Xr gzeof 3 ,
.Xr gzread 3 ,
.Xr gzwrite 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
|