summary refs log tree commit diff
path: root/doc/zlib/deflateEnd.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
commitfe5829caffb9fb44a142f8ca9b0213304b0df84a (patch)
tree1dd744f2648ba894dff816afe48ab4157beafc80 /doc/zlib/deflateEnd.3
parentAdd "this commit" option to switch form (diff)
parentReplace Makefile with portable one (diff)
downloadsrc-fe5829caffb9fb44a142f8ca9b0213304b0df84a.tar.gz
src-fe5829caffb9fb44a142f8ca9b0213304b0df84a.zip
Add 'doc/zlib/' from commit 'e1ebbcf0ed43f21dd504f1f109e5d12b6bc99460'
git-subtree-dir: doc/zlib
git-subtree-mainline: bc52b7578b0ebfc228977342ac7bffc999212197
git-subtree-split: e1ebbcf0ed43f21dd504f1f109e5d12b6bc99460
Diffstat (limited to 'doc/zlib/deflateEnd.3')
-rw-r--r--doc/zlib/deflateEnd.350
1 files changed, 50 insertions, 0 deletions
diff --git a/doc/zlib/deflateEnd.3 b/doc/zlib/deflateEnd.3
new file mode 100644
index 00000000..0abaabe1
--- /dev/null
+++ b/doc/zlib/deflateEnd.3
@@ -0,0 +1,50 @@
+.Dd January 15, 2017
+.Dt DEFLATEEND 3
+.Os
+.
+.Sh NAME
+.Nm deflateEnd
+.Nd free deflate stream
+.
+.Sh LIBRARY
+.Lb libz
+.
+.Sh SYNOPSIS
+.In zlib.h
+.Ft int
+.Fn deflateEnd "z_streamp strm"
+.
+.Sh DESCRIPTION
+All dynamically allocated data structures
+for this stream are freed.
+This function discards any unprocessed input
+and does not flush any pending output.
+.
+.Sh RETURN VALUES
+.Fn deflateEnd
+returns
+.Dv Z_OK
+if success,
+.Dv Z_STREAM_ERROR
+if the stream state was inconsistent,
+.Dv Z_DATA_ERROR
+if the stream was freed prematurely
+(some input or output was discarded).
+In the error case,
+.Fa msg
+may be set but then points to a static string
+(which must not be deallocated).
+.
+.Sh SEE ALSO
+.Xr deflate 3 ,
+.Xr deflateInit 3
+.
+.Sh HISTORY
+This manual page was converted from
+.In zlib.h
+to mdoc format by
+.An June 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