diff options
| author | Lasse Collin <lasse.collin@tukaani.org> | 2011-04-11 20:59:07 +0300 |
|---|---|---|
| committer | Lasse Collin <lasse.collin@tukaani.org> | 2011-04-11 20:59:07 +0300 |
| commit | 4a9905302a9e4a1601ae09d650d3f08ce98ae9ee (patch) | |
| tree | 3fb7fa25b64d03847a21e9932e298bccd6c999f4 /src/liblzma/api | |
| parent | liblzma: Use memzero() to initialize supported_actions[]. (diff) | |
| download | xz-4a9905302a9e4a1601ae09d650d3f08ce98ae9ee.tar.xz | |
liblzma: Document lzma_raw_(enc|dec)oder_memusage() better.
It didn't mention the return value that is used if
an error occurs.
Diffstat (limited to 'src/liblzma/api')
| -rw-r--r-- | src/liblzma/api/lzma/filter.h | 8 |
1 files changed, 6 insertions, 2 deletions
diff --git a/src/liblzma/api/lzma/filter.h b/src/liblzma/api/lzma/filter.h index efd036f7..e0bc163a 100644 --- a/src/liblzma/api/lzma/filter.h +++ b/src/liblzma/api/lzma/filter.h @@ -131,7 +131,9 @@ extern LZMA_API(lzma_ret) lzma_filters_copy(const lzma_filter *src, * .id == LZMA_VLI_UNKNOWN. * * \return Number of bytes of memory required for the given - * filter chain when encoding. + * filter chain when encoding. If an error occurs, + * for example due to unsupported filter chain, + * UINT64_MAX is returned. */ extern LZMA_API(uint64_t) lzma_raw_encoder_memusage(const lzma_filter *filters) lzma_nothrow lzma_attr_pure; @@ -148,7 +150,9 @@ extern LZMA_API(uint64_t) lzma_raw_encoder_memusage(const lzma_filter *filters) * .id == LZMA_VLI_UNKNOWN. * * \return Number of bytes of memory required for the given - * filter chain when decoding. + * filter chain when decoding. If an error occurs, + * for example due to unsupported filter chain, + * UINT64_MAX is returned. */ extern LZMA_API(uint64_t) lzma_raw_decoder_memusage(const lzma_filter *filters) lzma_nothrow lzma_attr_pure; |