about summary refs log tree commit diff homepage
path: root/gzsetparams.3
diff options
context:
space:
mode:
authorJune McEnroe <june@causal.agency>2018-11-12 16:53:29 -0500
committerJune McEnroe <june@causal.agency>2018-11-12 16:53:29 -0500
commit629024bec1c56ec7afb4fe40621ce2a772122f6e (patch)
tree3965190c92d1085ab7230c70d5f369c6fe14c9e1 /gzsetparams.3
parentAdd gzbuffer.3 (diff)
downloadzlib-man-pages-629024bec1c56ec7afb4fe40621ce2a772122f6e.tar.gz
zlib-man-pages-629024bec1c56ec7afb4fe40621ce2a772122f6e.zip
Add gzsetparams.3
Diffstat (limited to '')
-rw-r--r--gzsetparams.337
1 files changed, 37 insertions, 0 deletions
diff --git a/gzsetparams.3 b/gzsetparams.3
new file mode 100644
index 0000000..88ba96c
--- /dev/null
+++ b/gzsetparams.3
@@ -0,0 +1,37 @@
+.Dd November 12, 2018
+.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.