summaryrefslogtreecommitdiffstats
path: root/lib/lz4frame.h
diff options
context:
space:
mode:
authorYann Collet <yann.collet.73@gmail.com>2015-04-20 11:23:33 (GMT)
committerYann Collet <yann.collet.73@gmail.com>2015-04-20 11:23:33 (GMT)
commit72e679438f9ead31e671e0738b7730f846ebde70 (patch)
treeedda7e51fc894eb1b8d3791ba29c3098333ad92a /lib/lz4frame.h
parenta01e10dbdc58ae3bcef3348c6b196fc733b942b7 (diff)
downloadlz4-72e679438f9ead31e671e0738b7730f846ebde70.zip
lz4-72e679438f9ead31e671e0738b7730f846ebde70.tar.gz
lz4-72e679438f9ead31e671e0738b7730f846ebde70.tar.bz2
Updated LZ4F_freeDecompressionContext(), to provide stage hint as result
Diffstat (limited to 'lib/lz4frame.h')
-rw-r--r--lib/lz4frame.h2
1 files changed, 2 insertions, 0 deletions
diff --git a/lib/lz4frame.h b/lib/lz4frame.h
index 85ebce3..b5ba2fb 100644
--- a/lib/lz4frame.h
+++ b/lib/lz4frame.h
@@ -245,6 +245,8 @@ LZ4F_errorCode_t LZ4F_freeDecompressionContext(LZ4F_decompressionContext_t dctx)
* The function will provide a pointer to a fully allocated and initialized LZ4F_decompressionContext_t object.
* The result is an errorCode, which can be tested using LZ4F_isError().
* dctx memory can be released using LZ4F_freeDecompressionContext();
+ * The result of LZ4F_freeDecompressionContext() is indicative of the current state of decompressionContext when being released.
+ * That is, it should be == 0 if decompression has been completed fully and correctly.
*/