diff options
Diffstat (limited to 'librecrypt_encode.3')
| -rw-r--r-- | librecrypt_encode.3 | 25 |
1 files changed, 25 insertions, 0 deletions
diff --git a/librecrypt_encode.3 b/librecrypt_encode.3 index 95862f8..c38b59a 100644 --- a/librecrypt_encode.3 +++ b/librecrypt_encode.3 @@ -57,10 +57,23 @@ function returns the number of bytes that would have been written to .IR out_buffer , excluding the terminating null byte. +On failure, +.I SIZE_MAX +is returned and +.IR errno +is set to describe the error. .SH ERRORS The .BR librecrypt_encode () +function will fail if: +.TP +.B EOVERFLOW +.I ascii +uses an invalid encoding. + +The +.BR librecrypt_encode () function cannot fail. .SH ATTRIBUTES @@ -81,6 +94,18 @@ T} Async-signal safety AS-Safe .TE .sp +.SH NOTES +The value +.I SIZE_MAX +can be returned on both success and failure. +.I errno +is only modified on failure. For practical +purposes, applications can treat +.I SIZE_MAX +as indicating an +.I ENOMEM +failure. + .SH HISTORY The .BR librecrypt_encode () |