about summary refs log tree commit diff homepage
path: root/inflateCopy.3
blob: d1e7bfe90b48a052e32ccd52ccb1eb34edab85ed (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
.Dd November 11, 2018
.Dt INFLATECOPY 3
.Os
.
.Sh NAME
.Nm inflateCopy
.Nd copy inflate stream
.
.Sh LIBRARY
.Lb libz
.
.Sh SYNOPSIS
.In zlib.h
.Ft int
.Fn inflateCopy "z_streamp dest" "z_streamp source"
.
.Sh DESCRIPTION
Sets the destination stream
as a complete copy of the source stream.
.
.Pp
This function can be useful
when randomly accessing a large stream.
The first pass through the stream
can periodically record the inflate state,
allowing restarting inflate at those points
when randomly accessing the stream.
.
.Sh RETURN VALUES
.Fn inflateCopy
returns
.Dv Z_OK
if success,
.Dv Z_MEM_ERROR
if there was not enough memory,
.Dv Z_STREAM_ERROR
if the source stream state was inconsistent
.Po
such as
.Fa zalloc
being
.Dv Z_NULL
.Pc .
.Fa msg
is left unchanged
in both source and destination.