diff options
author | June McEnroe <june@causal.agency> | 2018-11-11 21:33:57 -0500 |
---|---|---|
committer | June McEnroe <june@causal.agency> | 2018-11-11 21:33:57 -0500 |
commit | 91d5510c862014166246a419724c2dcc171434ed (patch) | |
tree | fe5c7ea745649d82607599e74b36c76d08881269 | |
parent | Add inflateCopy.3 (diff) | |
download | zlib-man-pages-91d5510c862014166246a419724c2dcc171434ed.tar.gz zlib-man-pages-91d5510c862014166246a419724c2dcc171434ed.zip |
Add inflateReset.3
-rw-r--r-- | Makefile | 2 | ||||
-rw-r--r-- | inflateReset.3 | 67 |
2 files changed, 69 insertions, 0 deletions
diff --git a/Makefile b/Makefile index 121054e..0127b46 100644 --- a/Makefile +++ b/Makefile @@ -24,6 +24,7 @@ MAN += inflateEnd.3 MAN += inflateGetDictionary.3 MAN += inflateInit.3 MAN += inflateInit2.3 +MAN += inflateReset.3 MAN += inflateSetDictionary.3 MAN += inflateSync.3 MAN += uncompress.3 @@ -33,6 +34,7 @@ MAN += zlibVersion.3 MLINKS += adler32.3 adler32_z.3 MLINKS += compress.3 compress2.3 MLINKS += crc32.3 crc32_z.3 +MLINKS += inflateReset.3 inflateReset2.3 MLINKS += uncompress.3 uncompress2.3 .include <bsd.lib.mk> diff --git a/inflateReset.3 b/inflateReset.3 new file mode 100644 index 0000000..fa9c8cc --- /dev/null +++ b/inflateReset.3 @@ -0,0 +1,67 @@ +.Dd November 11, 2018 +.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. |