diff options
| author | Mattias Andrée <maandree@kth.se> | 2022-02-14 00:03:02 +0100 |
|---|---|---|
| committer | Mattias Andrée <maandree@kth.se> | 2022-02-14 00:03:02 +0100 |
| commit | c9e67109d0425fbb1d371200eefec858ae11c0bf (patch) | |
| tree | 9e5bae57a8726d16c7e268663da29882e0516665 /libar2_hash_buf_size.3 | |
| parent | Add libar2_hash_buf_size and fix related documentation for libar2_hash (diff) | |
| download | libar2-c9e67109d0425fbb1d371200eefec858ae11c0bf.tar.gz libar2-c9e67109d0425fbb1d371200eefec858ae11c0bf.tar.bz2 libar2-c9e67109d0425fbb1d371200eefec858ae11c0bf.tar.xz | |
Fix previous commit
Diffstat (limited to 'libar2_hash_buf_size.3')
| -rw-r--r-- | libar2_hash_buf_size.3 | 23 |
1 files changed, 17 insertions, 6 deletions
diff --git a/libar2_hash_buf_size.3 b/libar2_hash_buf_size.3 index f538cfc..dcb8285 100644 --- a/libar2_hash_buf_size.3 +++ b/libar2_hash_buf_size.3 @@ -26,19 +26,30 @@ may not be .PP The return value is .I params->hashlen -if this number is 64 or less, otherwise it is +if this number is 64 or less, a multiple of 128 +that is around twice as large as .I params->hashlen -rounded up to the next multiple of 128. +(can be a bit more). .SH RETURN VALUES -See -.BR DESCRIPTION . +The +.BR libar2_hash_buf_size () +function returns the number of bytes that the +output buffer size for the +.BR libar2_hash (3) +function upon successful completion. On failure +0 is returned and +.I errno +is set to describe the error. .SH ERRORS The .BR libar2_hash_buf_size () -function cannot fail; however, if the -return value is 0, the value has overflown. +function will fail if: +.TP +.B EOVERFLOW +The resulting value is too large to fit +in the return type. .SH SEE ALSO .BR libar2 (7), |