summaryrefslogtreecommitdiff
path: root/zlib.h
diff options
context:
space:
mode:
authorMark Adler <madler@alumni.caltech.edu>2014-04-26 08:12:37 -0700
committerMark Adler <madler@alumni.caltech.edu>2014-04-26 08:12:37 -0700
commit9cbda797c10b16d7a369761ed6d5a68f26296ce6 (patch)
tree8a131a6e5389a750572660f8c09cb5fc459ed1bf /zlib.h
parent7d54c69413ed2275b9ea25b376627294ffac5ca8 (diff)
downloadzlib-9cbda797c10b16d7a369761ed6d5a68f26296ce6.tar.gz
Note in zlib.h that compress() uses Z_DEFAULT_COMPRESSION.
Diffstat (limited to 'zlib.h')
-rw-r--r--zlib.h3
1 files changed, 2 insertions, 1 deletions
diff --git a/zlib.h b/zlib.h
index 9856056..11a659a 100644
--- a/zlib.h
+++ b/zlib.h
@@ -1164,7 +1164,8 @@ ZEXTERN int ZEXPORT compress OF((Bytef *dest, uLongf *destLen,
the byte length of the source buffer. Upon entry, destLen is the total size
of the destination buffer, which must be at least the value returned by
compressBound(sourceLen). Upon exit, destLen is the actual size of the
- compressed buffer.
+ compressed buffer. compress() is equivalent to compress2() with a level
+ parameter of Z_DEFAULT_COMPRESSION.
compress returns Z_OK if success, Z_MEM_ERROR if there was not
enough memory, Z_BUF_ERROR if there was not enough room in the output