diff options
| author | June McEnroe <june@causal.agency> | 2018-11-11 16:44:07 -0500 |
|---|---|---|
| committer | June McEnroe <june@causal.agency> | 2018-11-11 16:44:07 -0500 |
| commit | dc6a079f1d013dc811ce5b03db46c3f267f17508 (patch) | |
| tree | f3d41ff3d185f96aed5371683d315437659d7c83 /deflateEnd.3 | |
| parent | Separate out deflateGetDictionary.3 (diff) | |
| download | zlib-man-pages-dc6a079f1d013dc811ce5b03db46c3f267f17508.tar.gz zlib-man-pages-dc6a079f1d013dc811ce5b03db46c3f267f17508.zip | |
Separate out deflateInit.3 and deflateEnd.3
Diffstat (limited to '')
| -rw-r--r--[l---------] | deflateEnd.3 | 41 |
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 |