blob: 0abaabe1a1eb38b3f037b11f17f07e536e95b481 (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
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
|