diff options
| author | Yann Collet <cyan@fb.com> | 2017-05-10 23:28:36 (GMT) |
|---|---|---|
| committer | Yann Collet <cyan@fb.com> | 2017-05-10 23:28:36 (GMT) |
| commit | e60cbb5cacaa43eda7a3df7c2d9051a9437e7046 (patch) | |
| tree | 0c7825e9a62639c15380479e9ca49596e0022e7e /doc | |
| parent | 2012e4de9e2c33a5abb34d40082afc8918852c6e (diff) | |
| download | lz4-e60cbb5cacaa43eda7a3df7c2d9051a9437e7046.zip lz4-e60cbb5cacaa43eda7a3df7c2d9051a9437e7046.tar.gz lz4-e60cbb5cacaa43eda7a3df7c2d9051a9437e7046.tar.bz2 | |
added test for LZ4F_resetDecompressionContext()
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/lz4frame_manual.html | 9 |
1 files changed, 3 insertions, 6 deletions
diff --git a/doc/lz4frame_manual.html b/doc/lz4frame_manual.html index fa2c0b9..87750a1 100644 --- a/doc/lz4frame_manual.html +++ b/doc/lz4frame_manual.html @@ -255,14 +255,11 @@ LZ4F_errorCode_t LZ4F_freeDecompressionContext(LZ4F_dctx* dctx); </p></pre><BR> -<pre><b>LZ4F_errorCode_t LZ4F_resetDecompressionContext(LZ4F_dctx* dctx); -</b><p> When decompression ends successfully, - it's possible to start a new decompression immediately - re-using the same context. - However, in case of an error, the context is left in "undefined" state. +<pre><b>void LZ4F_resetDecompressionContext(LZ4F_dctx* dctx); </b>/* always successful */<b> +</b><p> In case of an error, the context is left in "undefined" state. In which case, it's necessary to reset it, before re-using it. This method can also be used to abruptly stop an unfinished decompression, - and start a new on the same context. + and start a new with the same context. </p></pre><BR> </html> |