summary refs log tree commit diff
path: root/doc/zlib/inflateSync.3
blob: 35264ddd33e9248c744146c028eb011a451a2ab1 (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
.Dd January 15, 2017
.Dt INFLATESYNC 3
.Os
.
.Sh NAME
.Nm inflateSync
.Nd skip invalid data
.
.Sh LIBRARY
.Lb libz
.
.Sh SYNOPSIS
.In zlib.h
.Ft int
.Fn inflateSync "z_streamp strm"
.
.Sh DESCRIPTION
Skips invalid compressed data
until a possible full flush point
.Po
see
.Xr deflate 3
for the description of
.Dv Z_FULL_FLUSH
.Pc
can be found,
or until all available input is skipped.
No output is provided.
.
.Pp
.Fn inflateSync
searches for a 00 00 FF FF pattern
in the compressed data.
All full flush points have this pattern,
but not all occurrences of this pattern
are full flush points.
.
.Sh RETURN VALUES
.Fn inflateSync
returns
.Dv Z_OK
if a possible full flush point has been found,
.Dv Z_BUF_ERROR
if no more input was provided,
.Dv Z_DATA_ERROR
if no flush point has been found,
or
.Dv Z_STREAM_ERROR
if the stream structure was inconsistent.
In the success case,
the application may save the current value of
.Fa total_in
which indicates where valid compressed data was found.
In the error case,
the application may repeatedly call
.Fn inflateSync ,
providing more input each time,
until success or the end of the input data.
.
.Sh SEE ALSO
.Xr deflate 3 ,
.Xr inflate 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