diff options
author | PW Hu <jlu.hpw@foxmail.com> | 2021-10-07 11:40:49 +0800 |
---|---|---|
committer | Tomas Mraz <tomas@openssl.org> | 2021-10-22 11:54:11 +0200 |
commit | 5001287c0dcd8ca4ffc564b360f86df79bba40c1 (patch) | |
tree | 2b49b19882329baa9bf11e4898a7c4881a82037a /doc/man3/BIO_s_connect.pod | |
parent | f1d077f1108b1bc2334350a4d53a46e29e082910 (diff) | |
download | openssl-5001287c0dcd8ca4ffc564b360f86df79bba40c1.tar.gz |
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_s_connect.pod')
-rw-r--r-- | doc/man3/BIO_s_connect.pod | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/doc/man3/BIO_s_connect.pod b/doc/man3/BIO_s_connect.pod index f31da27fe7..76ed7337ea 100644 --- a/doc/man3/BIO_s_connect.pod +++ b/doc/man3/BIO_s_connect.pod @@ -141,9 +141,9 @@ BIO_set_nbio(), and BIO_do_connect() are macros. BIO_s_connect() returns the connect BIO method. BIO_set_conn_address(), BIO_set_conn_port(), and BIO_set_conn_ip_family() -always return 1. +return 1 or <=0 if an error occurs. -BIO_set_conn_hostname() returns 1 on success and 0 on failure. +BIO_set_conn_hostname() returns 1 on success and <=0 on failure. BIO_get_conn_address() returns the address information or NULL if none was set. @@ -156,10 +156,10 @@ BIO_get_conn_ip_family() returns the address family or -1 if none was set. BIO_get_conn_port() returns a string representing the connected port or NULL if not set. -BIO_set_nbio() always returns 1. +BIO_set_nbio() returns 1 or <=0 if an error occurs. BIO_do_connect() returns 1 if the connection was successfully -established and 0 or -1 if the connection failed. +established and <=0 if the connection failed. =head1 EXAMPLES |