blob: cbb78a7720c458491e925cea05d4519025ef2838 (
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
|
.Dd January 15, 2017
.Dt GZOFFSET 3
.Os
.
.Sh NAME
.Nm gzoffset
.Nd offset in compressed file
.
.Sh LIBRARY
.Lb libz
.
.Sh SYNOPSIS
.In zlib.h
.Ft z_off_t
.Fn gzoffset "gzFile file"
.
.Sh DESCRIPTION
Returns the current offset
in the file being read or written.
This offset includes
the count of bytes
that precede the gzip stream,
for example when appending
or when using
.Xr gzdopen 3
for reading.
When reading,
the offset does not include
as yet unused buffered input.
This information can be used
for a progress indicator.
.
.Sh RETURN VALUES
On error,
.Fn gzoffset
returns -1.
.
.Sh SEE ALSO
.Xr gzerror 3 ,
.Xr gzopen 3 ,
.Xr gzseek 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
|