summary refs log tree commit diff
path: root/doc/zlib/compressBound.3
blob: 5800e2ba552e4466561f650109cdcbc940f639c5 (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
.Dd January 15, 2017
.Dt COMPRESSBOUND 3
.Os
.
.Sh NAME
.Nm compressBound
.Nd compressed size upper bound
.
.Sh LIBRARY
.Lb libz
.
.Sh SYNOPSIS
.In zlib.h
.Ft uLong
.Fn compressBound "uLong sourceLen"
.
.Sh DESCRIPTION
.Fn compressBound
returns an upper bound on the compressed size after
.Xr compress 3
or
.Xr compress2 3
on
.Fa sourceLen
bytes.
It would be used before a
.Xr compress 3
or
.Xr compress2 3
call to allocate the destination buffer.
.
.Sh SEE ALSO
.Xr compress 3 ,
.Xr deflateBound 3
.
.Sh HISTORY
This manual page was converted from
.In zlib.h
to mdoc format by
.An C. 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