summaryrefslogtreecommitdiffstats
path: root/doc/man3/BIO_s_file.pod
diff options
context:
space:
mode:
authorPeiwei Hu <58985155+PeiweiHu@users.noreply.github.com>2021-09-26 15:44:42 +0800
committerPauli <pauli@openssl.org>2021-09-28 18:17:27 +1000
commit4ff1639adb732f0f49652ed22124df2c0b199726 (patch)
tree9f502e3e4bffbd1c6088a589e9391d33609b1729 /doc/man3/BIO_s_file.pod
parent144562d412580f58656d64959bfe6d4794fef6a2 (diff)
Fix some documentation errors
CLA: trivial Reviewed-by: Tomas Mraz <tomas@openssl.org> Reviewed-by: Paul Dale <pauli@openssl.org> (Merged from https://github.com/openssl/openssl/pull/16684) (cherry picked from commit 9efdf4ad6b130aa4e206a8fd612539925c0b1e45)
Diffstat (limited to 'doc/man3/BIO_s_file.pod')
-rw-r--r--doc/man3/BIO_s_file.pod8
1 files changed, 4 insertions, 4 deletions
diff --git a/doc/man3/BIO_s_file.pod b/doc/man3/BIO_s_file.pod
index c2beb7f924..aaaf2dc39e 100644
--- a/doc/man3/BIO_s_file.pod
+++ b/doc/man3/BIO_s_file.pod
@@ -87,7 +87,7 @@ BIO_s_file() returns the file BIO method.
BIO_new_file() and BIO_new_fp() return a file BIO or NULL if an error
occurred.
-BIO_set_fp() and BIO_get_fp() return 1 for success or 0 for failure
+BIO_set_fp() and BIO_get_fp() return 1 for success or <=0 for failure
(although the current implementation never return 0).
BIO_seek() returns the same value as the underlying fseek() function:
@@ -96,7 +96,7 @@ BIO_seek() returns the same value as the underlying fseek() function:
BIO_tell() returns the current file position.
BIO_read_filename(), BIO_write_filename(), BIO_append_filename() and
-BIO_rw_filename() return 1 for success or 0 for failure.
+BIO_rw_filename() return 1 for success or <=0 for failure.
=head1 EXAMPLES
@@ -114,7 +114,7 @@ Alternative technique:
bio_out = BIO_new(BIO_s_file());
if (bio_out == NULL)
/* Error */
- if (!BIO_set_fp(bio_out, stdout, BIO_NOCLOSE))
+ if (BIO_set_fp(bio_out, stdout, BIO_NOCLOSE) <= 0)
/* Error */
BIO_printf(bio_out, "Hello World\n");
@@ -135,7 +135,7 @@ Alternative technique:
out = BIO_new(BIO_s_file());
if (out == NULL)
/* Error */
- if (!BIO_write_filename(out, "filename.txt"))
+ if (BIO_write_filename(out, "filename.txt") <= 0)
/* Error */
BIO_printf(out, "Hello World\n");
BIO_free(out);