diff options
| author | Mark Adler <madler@alumni.caltech.edu> | 2015-07-28 23:17:49 -0700 |
|---|---|---|
| committer | Mark Adler <madler@alumni.caltech.edu> | 2015-07-28 23:19:50 -0700 |
| commit | 5701f48cf5178355b1ec51614d44aa14251250e5 (patch) | |
| tree | 518331f3b47e3e96824f1d6f8fd31d64bd27e58e | |
| parent | c901a34c92c4aa74028f541a9773df726ce2b769 (diff) | |
| download | zlib-5701f48cf5178355b1ec51614d44aa14251250e5.tar.gz zlib-5701f48cf5178355b1ec51614d44aa14251250e5.tar.bz2 zlib-5701f48cf5178355b1ec51614d44aa14251250e5.zip | |
Clarify deflateReset() documentation.
It previously could have been misinterpreted to mean that parameter
changes after deflateInit2() would be reversed, which is not the
case.
| -rw-r--r-- | zlib.h | 8 |
1 files changed, 4 insertions, 4 deletions
| @@ -656,10 +656,10 @@ ZEXTERN int ZEXPORT deflateCopy OF((z_streamp dest, | |||
| 656 | 656 | ||
| 657 | ZEXTERN int ZEXPORT deflateReset OF((z_streamp strm)); | 657 | ZEXTERN int ZEXPORT deflateReset OF((z_streamp strm)); |
| 658 | /* | 658 | /* |
| 659 | This function is equivalent to deflateEnd followed by deflateInit, | 659 | This function is equivalent to deflateEnd followed by deflateInit, but |
| 660 | but does not free and reallocate all the internal compression state. The | 660 | does not free and reallocate the internal compression state. The stream |
| 661 | stream will keep the same compression level and any other attributes that | 661 | will leave the compression level and any other attributes that may have been |
| 662 | may have been set by deflateInit2. | 662 | set unchanged. |
| 663 | 663 | ||
| 664 | deflateReset returns Z_OK if success, or Z_STREAM_ERROR if the source | 664 | deflateReset returns Z_OK if success, or Z_STREAM_ERROR if the source |
| 665 | stream state was inconsistent (such as zalloc or state being Z_NULL). | 665 | stream state was inconsistent (such as zalloc or state being Z_NULL). |