blob: 6500343f657a5ea28dbbf39e16ff62c6066ee949 (
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
|
.Dd January 15, 2017
.Dt DEFLATECOPY 3
.Os
.
.Sh NAME
.Nm deflateCopy
.Nd copy deflate stream
.
.Sh LIBRARY
.Lb libz
.
.Sh SYNOPSIS
.In zlib.h
.Ft int
.Fn deflateCopy "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
several compression strategies will be tried,
for example when there are several ways of
pre-processing the input data with a filter.
The streams that will be discarded
should then be freed by calling
.Xr deflateEnd 3 .
Note that
.Fn deflateCopy
duplicates the internal compression state
which can be quite large,
so this strategy is slow
and can consume lots of memory.
.
.Sh RETURN VALUES
.Fn deflateCopy
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.
|