summaryrefslogtreecommitdiffstats
path: root/lib/lz4frame.h
diff options
context:
space:
mode:
authorYann Collet <cyan@fb.com>2022-07-13 19:39:59 (GMT)
committerYann Collet <cyan@fb.com>2022-07-13 19:39:59 (GMT)
commita3c4f0d0a31580da09a955b6783203d6c383a9e4 (patch)
tree6538a97ea19cd360940cfea630c3784784bb9b11 /lib/lz4frame.h
parentc76c9c53ace36ce340d29d1df5eeedd8ba4d43bc (diff)
downloadlz4-a3c4f0d0a31580da09a955b6783203d6c383a9e4.zip
lz4-a3c4f0d0a31580da09a955b6783203d6c383a9e4.tar.gz
lz4-a3c4f0d0a31580da09a955b6783203d6c383a9e4.tar.bz2
implemented LZ4F_createDecompressionContext_advanced()
Diffstat (limited to 'lib/lz4frame.h')
-rw-r--r--lib/lz4frame.h8
1 files changed, 5 insertions, 3 deletions
diff --git a/lib/lz4frame.h b/lib/lz4frame.h
index 1b4ee76..0d2ebf9 100644
--- a/lib/lz4frame.h
+++ b/lib/lz4frame.h
@@ -364,9 +364,10 @@ typedef struct {
/*! LZ4F_createDecompressionContext() :
* Create an LZ4F_dctx object, to track all decompression operations.
- * The version provided MUST be LZ4F_VERSION.
- * The function provides a pointer to an allocated and initialized LZ4F_dctx object.
- * The result is an errorCode, which can be tested using LZ4F_isError().
+ * @version provided MUST be LZ4F_VERSION.
+ * @dctxPtr MUST be valid.
+ * The function fills @dctxPtr with the value of a pointer to an allocated and initialized LZ4F_dctx object.
+ * The @return is an errorCode, which can be tested using LZ4F_isError().
* dctx memory can be released using LZ4F_freeDecompressionContext();
* Result of LZ4F_freeDecompressionContext() indicates current state of decompressionContext when being released.
* That is, it should be == 0 if decompression has been completed fully and correctly.
@@ -571,6 +572,7 @@ __attribute__((__unused__))
LZ4F_CustomMem const LZ4F_defaultCMem = { NULL, NULL, NULL, NULL }; /**< this constant defers to stdlib's functions */
LZ4FLIB_STATIC_API LZ4F_cctx* LZ4F_createCompressionContext_advanced(LZ4F_CustomMem customMem, unsigned version);
+LZ4FLIB_STATIC_API LZ4F_dctx* LZ4F_createDecompressionContext_advanced(LZ4F_CustomMem customMem, unsigned version);
/*! LZ4F_getBlockSize() :