wolfSSL/wolfssl
1
0
Fork 1
mirror of https://github.com/wolfSSL/wolfssl.git synced 2025-08-01 03:34:39 +02:00
Code Issues Packages Projects Releases Wiki Activity

wolfSSL_get_error may return SSL_ERROR_NONE on ret <= 0

Browse Source 
Fix docs mismatch reported in https://github.com/wolfSSL/wolfssl/issues/4854
This commit is contained in:
Juliusz Sosinowicz
2022-02-11 12:37:12 +01:00
parent 34b6102816
commit 4f8ffc4586
1 changed files with 8 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
doc/dox_comments/header_files/ssl.h
View File

@@ -2190,9 +2190,15 @@ WOLFSSL_API int wolfSSL_recv(WOLFSSL*, void*, int sz, int flags);
human-readable error string. See wolfSSL_ERR_error_string() for more
information.
\return code On successful completion, this function will return the
\return On successful completion, this function will return the
unique error code describing why the previous API function failed.
\return SSL_ERROR_NONE will be returned if ret > 0.
\return SSL_ERROR_NONE will be returned if ret > 0. For ret <= 0, there are
some cases when this value can also be returned when a previous API appeared
to return an error code but no error actually occurred. An example is
calling wolfSSL_read() with a zero sz parameter. A 0 return from
wolfSSL_read() usually indicates an error but in this case no error
occurred. If wolfSSL_get_error() is called afterwards, SSL_ERROR_NONE will
be returned.
\param ssl pointer to the SSL object, created with wolfSSL_new().
\param ret return value of the previous function that resulted in an error