mirror of https://git.tukaani.org/xz.git
liblzma: Update API docs about decoder flags.
This commit is contained in:
parent
8779a9db5d
commit
4746f5ec72
|
@ -73,7 +73,8 @@ typedef struct {
|
||||||
*
|
*
|
||||||
* Decoder: Bitwise-or of zero or more of the decoder flags:
|
* Decoder: Bitwise-or of zero or more of the decoder flags:
|
||||||
* LZMA_TELL_NO_CHECK, LZMA_TELL_UNSUPPORTED_CHECK,
|
* LZMA_TELL_NO_CHECK, LZMA_TELL_UNSUPPORTED_CHECK,
|
||||||
* LZMA_TELL_ANY_CHECK, LZMA_CONCATENATED, LZMA_FAIL_FAST
|
* LZMA_TELL_ANY_CHECK, LZMA_IGNORE_CHECK,
|
||||||
|
* LZMA_CONCATENATED, LZMA_FAIL_FAST
|
||||||
*/
|
*/
|
||||||
uint32_t flags;
|
uint32_t flags;
|
||||||
|
|
||||||
|
@ -655,7 +656,8 @@ extern LZMA_API(lzma_ret) lzma_microlzma_encoder(
|
||||||
* had been specified.
|
* had been specified.
|
||||||
* \param flags Bitwise-or of zero or more of the decoder flags:
|
* \param flags Bitwise-or of zero or more of the decoder flags:
|
||||||
* LZMA_TELL_NO_CHECK, LZMA_TELL_UNSUPPORTED_CHECK,
|
* LZMA_TELL_NO_CHECK, LZMA_TELL_UNSUPPORTED_CHECK,
|
||||||
* LZMA_TELL_ANY_CHECK, LZMA_CONCATENATED
|
* LZMA_TELL_ANY_CHECK, LZMA_IGNORE_CHECK,
|
||||||
|
* LZMA_CONCATENATED, LZMA_FAIL_FAST
|
||||||
*
|
*
|
||||||
* \return - LZMA_OK: Initialization was successful.
|
* \return - LZMA_OK: Initialization was successful.
|
||||||
* - LZMA_MEM_ERROR: Cannot allocate memory.
|
* - LZMA_MEM_ERROR: Cannot allocate memory.
|
||||||
|
@ -704,13 +706,23 @@ extern LZMA_API(lzma_ret) lzma_stream_decoder_mt(
|
||||||
* calls lzma_stream_decoder() or lzma_alone_decoder() once the type
|
* calls lzma_stream_decoder() or lzma_alone_decoder() once the type
|
||||||
* of the input file has been detected.
|
* of the input file has been detected.
|
||||||
*
|
*
|
||||||
|
* If the flag LZMA_CONCATENATED is used and the input is a .lzma file:
|
||||||
|
* For historical reasons concatenated .lzma files aren't supported.
|
||||||
|
* If there is trailing data after one .lzma stream, lzma_code() will
|
||||||
|
* return LZMA_DATA_ERROR. (lzma_alone_decoder() doesn't have such a check
|
||||||
|
* as it doesn't support any decoder flags. It will return LZMA_STREAM_END
|
||||||
|
* after one .lzma stream.)
|
||||||
|
*
|
||||||
* \param strm Pointer to properly prepared lzma_stream
|
* \param strm Pointer to properly prepared lzma_stream
|
||||||
* \param memlimit Memory usage limit as bytes. Use UINT64_MAX
|
* \param memlimit Memory usage limit as bytes. Use UINT64_MAX
|
||||||
* to effectively disable the limiter. liblzma
|
* to effectively disable the limiter. liblzma
|
||||||
* 5.2.3 and earlier don't allow 0 here and return
|
* 5.2.3 and earlier don't allow 0 here and return
|
||||||
* LZMA_PROG_ERROR; later versions treat 0 as if 1
|
* LZMA_PROG_ERROR; later versions treat 0 as if 1
|
||||||
* had been specified.
|
* had been specified.
|
||||||
* \param flags Bitwise-or of flags, or zero for no flags.
|
* \param flags Bitwise-or of zero or more of the decoder flags:
|
||||||
|
* LZMA_TELL_NO_CHECK, LZMA_TELL_UNSUPPORTED_CHECK,
|
||||||
|
* LZMA_TELL_ANY_CHECK, LZMA_IGNORE_CHECK,
|
||||||
|
* LZMA_CONCATENATED, LZMA_FAIL_FAST
|
||||||
*
|
*
|
||||||
* \return - LZMA_OK: Initialization was successful.
|
* \return - LZMA_OK: Initialization was successful.
|
||||||
* - LZMA_MEM_ERROR: Cannot allocate memory.
|
* - LZMA_MEM_ERROR: Cannot allocate memory.
|
||||||
|
@ -754,7 +766,8 @@ extern LZMA_API(lzma_ret) lzma_alone_decoder(
|
||||||
* returned.
|
* returned.
|
||||||
* \param flags Bitwise-or of zero or more of the decoder flags:
|
* \param flags Bitwise-or of zero or more of the decoder flags:
|
||||||
* LZMA_TELL_NO_CHECK, LZMA_TELL_UNSUPPORTED_CHECK,
|
* LZMA_TELL_NO_CHECK, LZMA_TELL_UNSUPPORTED_CHECK,
|
||||||
* LZMA_CONCATENATED. Note that LZMA_TELL_ANY_CHECK
|
* LZMA_IGNORE_CHECK, LZMA_CONCATENATED,
|
||||||
|
* LZMA_FAIL_FAST. Note that LZMA_TELL_ANY_CHECK
|
||||||
* is not allowed and will return LZMA_PROG_ERROR.
|
* is not allowed and will return LZMA_PROG_ERROR.
|
||||||
* \param allocator lzma_allocator for custom allocator functions.
|
* \param allocator lzma_allocator for custom allocator functions.
|
||||||
* Set to NULL to use malloc() and free().
|
* Set to NULL to use malloc() and free().
|
||||||
|
|
Loading…
Reference in New Issue