summary refs log tree commit diff
path: root/doc/zlib/gzungetc.3
blob: 90cdafc7fdff518aebe89658bddd05700fc114b7 (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
.Dd January 15, 2017
.Dt GZUNGETC 3
.Os
.
.Sh NAME
.Nm gzungetc
.Nd un-get character from compressed file
.
.Sh LIBRARY
.Lb libz
.
.Sh SYNOPSIS
.In zlib.h
.Ft int
.Fn gzungetc "int c" "gzFile file"
.
.Sh DESCRIPTION
Push one character back onto the stream
to be read as the first character
on the next read.
At least one character of push-back
is allowed.
.Fn gzungetc
will fail if
.Fa c
is -1,
and may fail if a character
has been pushed
but not read yet.
If
.Fn gzungetc
is used immediately after
.Xr gzopen 3
or
.Xr gzdopen 3 ,
at least the output buffer size
of pushed characters is allowed.
.Po
See
.Xr gzbuffer 3 .
.Pc \&
The pushed character will be discarded
if the stream is repositioned with
.Xr gzseek 3
or
.Xr gzrewind 3 .
.
.Sh RETURN VALUES
.Fn gzungetc
returns the character pushed,
or -1 on failure.
.
.Sh SEE ALSO
.Xr gzbuffer 3 ,
.Xr gzerror 3 ,
.Xr gzgetc 3 ,
.Xr gzopen 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