summaryrefslogtreecommitdiffstats
path: root/doc/man3/BIO_f_buffer.pod
diff options
context:
space:
mode:
authorPW Hu <jlu.hpw@foxmail.com>2021-10-07 05:40:49 +0200
committerTomas Mraz <tomas@openssl.org>2021-10-22 11:54:11 +0200
commit5001287c0dcd8ca4ffc564b360f86df79bba40c1 (patch)
tree2b49b19882329baa9bf11e4898a7c4881a82037a /doc/man3/BIO_f_buffer.pod
parentFix some documentation errors related to return values (diff)
downloadopenssl-5001287c0dcd8ca4ffc564b360f86df79bba40c1.tar.xz
openssl-5001287c0dcd8ca4ffc564b360f86df79bba40c1.zip
Fix documentation errors, mainly caused by return values of BIO_ctrl
Reviewed-by: Shane Lontis <shane.lontis@oracle.com> Reviewed-by: Tomas Mraz <tomas@openssl.org> (Merged from https://github.com/openssl/openssl/pull/16767)
Diffstat (limited to 'doc/man3/BIO_f_buffer.pod')
-rw-r--r--doc/man3/BIO_f_buffer.pod7
1 files changed, 4 insertions, 3 deletions
diff --git a/doc/man3/BIO_f_buffer.pod b/doc/man3/BIO_f_buffer.pod
index ed32e11d92..2eb6e8eab1 100644
--- a/doc/man3/BIO_f_buffer.pod
+++ b/doc/man3/BIO_f_buffer.pod
@@ -74,12 +74,13 @@ source/sink BIO is non blocking.
BIO_f_buffer() returns the buffering BIO method.
-BIO_get_buffer_num_lines() returns the number of lines buffered (may be 0).
+BIO_get_buffer_num_lines() returns the number of lines buffered (may be 0) or
+a negative value in case of errors.
BIO_set_read_buffer_size(), BIO_set_write_buffer_size() and BIO_set_buffer_size()
-return 1 if the buffer was successfully resized or 0 for failure.
+return 1 if the buffer was successfully resized or <=0 for failure.
-BIO_set_buffer_read_data() returns 1 if the data was set correctly or 0 if
+BIO_set_buffer_read_data() returns 1 if the data was set correctly or <=0 if
there was an error.
=head1 SEE ALSO