summary refs log tree commit diff
path: root/doc/zlib/inflateReset.3
diff options
context:
space:
mode:
authorJune McEnroe <june@causal.agency>2020-12-27 22:11:35 -0500
committerJune McEnroe <june@causal.agency>2020-12-27 22:11:35 -0500
commit98ea1a27fc5e0377b13213e009f0c236f5fe73b4 (patch)
tree94c59aaaca157159510c1f81edba1d5e66cfdd64 /doc/zlib/inflateReset.3
parentAdd "this commit" option to switch form (diff)
parentReplace Makefile with portable one (diff)
downloadsrc-98ea1a27fc5e0377b13213e009f0c236f5fe73b4.tar.gz
src-98ea1a27fc5e0377b13213e009f0c236f5fe73b4.zip
Add 'doc/zlib/' from commit '38f010d3972db4262e7e0bcd7d6b9814f95d3538'
git-subtree-dir: doc/zlib
git-subtree-mainline: db652695744cc54584296b54289166b4b21ac407
git-subtree-split: 38f010d3972db4262e7e0bcd7d6b9814f95d3538
Diffstat (limited to 'doc/zlib/inflateReset.3')
-rw-r--r--doc/zlib/inflateReset.381
1 files changed, 81 insertions, 0 deletions
diff --git a/doc/zlib/inflateReset.3 b/doc/zlib/inflateReset.3
new file mode 100644
index 00000000..a8d2e219
--- /dev/null
+++ b/doc/zlib/inflateReset.3
@@ -0,0 +1,81 @@
+.Dd January 15, 2017
+.Dt INFLATERESET 3
+.Os
+.
+.Sh NAME
+.Nm inflateReset ,
+.Nm inflateReset2
+.Nd reset inflate stream
+.
+.Sh LIBRARY
+.Lb libz
+.
+.Sh SYNOPSIS
+.In zlib.h
+.Ft int
+.Fn inflateReset "z_streamp strm"
+.Ft int
+.Fn inflateReset2 "z_streamp strm" "int windowBits"
+.
+.Sh DESCRIPTION
+This function is equivalent to
+.Xr inflateEnd 3
+followed by
+.Xr inflateInit 3 ,
+but does not free and reallocate
+the internal decompression state.
+The stream will keep attributes
+that may have been set by
+.Xr inflateInit2 3 .
+.
+.Pp
+.Fn inflateReset2
+is the same as
+.Fn inflateReset ,
+but it also permits changing
+the wrap and window size requests.
+The
+.Fa windowBits
+parameter is interpreted the same as it is for
+.Xr inflateInit2 3 .
+If the window size is changed,
+then the memory allocated for the window is freed,
+and the window will be reallocated by
+.Xr inflate 3
+if needed.
+.
+.Sh RETURN VALUES
+.Fn inflateReset
+and
+.Fn inflateReset2
+return
+.Dv Z_OK
+if success,
+or
+.Dv Z_STREAM_ERROR
+if the source stream state was inconsistent
+.Po
+such as
+.Fa zalloc
+or
+.Fa state
+being
+.Dv Z_NULL
+.Pc ,
+or if the
+.Fa windowBits
+parameter is invalid.
+.
+.Sh SEE ALSO
+.Xr inflateEnd 3 ,
+.Xr inflateInit 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