about summary refs log tree commit diff homepage
path: root/gzsetparams.3
blob: 983b5828c53537f5a67b188f558e6dcd1c2ff80e (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
.Dd January 15, 2017
.Dt GZSETPARAMS 3
.Os
.
.Sh NAME
.Nm gzsetparams
.Nd set compression level and strategy
.
.Sh LIBRARY
.Lb libz
.
.Sh SYNOPSIS
.In zlib.h
.Ft int
.Fn gzsetparams "gzFile file" "int level" "int strategy"
.
.Sh DESCRIPTION
Dynamically update the compression level or strategy.
See the description of
.Xr deflateInit2 3
for the meaning
of these parameters.
Previously provided data is flushed
before the parameter change.
.
.Sh RETURN VALUES
.Fn gzsetparams
returns
.Dv Z_OK
if success,
.Dv Z_STREAM_ERROR
if the file was not opened for writing,
.Dv Z_ERRNO
if there is an error writing the flushed data,
or
.Dv Z_MEM_ERROR
if there is a memory allocation error.