about summary refs log tree commit diff homepage
path: root/deflateEnd.3
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--[l---------]deflateEnd.341
1 files changed, 40 insertions, 1 deletions
diff --git a/deflateEnd.3 b/deflateEnd.3
index 7d7a5e2..8818c91 120000..100644
--- a/deflateEnd.3
+++ b/deflateEnd.3
@@ -1 +1,40 @@
-deflate.3
\ No newline at end of file
+.Dd November 9, 2018
+.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