aboutsummaryrefslogtreecommitdiff
path: root/secure/lib/libcrypto/man/man3/BIO_s_file.3
diff options
context:
space:
mode:
Diffstat (limited to 'secure/lib/libcrypto/man/man3/BIO_s_file.3')
-rw-r--r--secure/lib/libcrypto/man/man3/BIO_s_file.337
1 files changed, 18 insertions, 19 deletions
diff --git a/secure/lib/libcrypto/man/man3/BIO_s_file.3 b/secure/lib/libcrypto/man/man3/BIO_s_file.3
index e3c865f498ce..76ed24a86e46 100644
--- a/secure/lib/libcrypto/man/man3/BIO_s_file.3
+++ b/secure/lib/libcrypto/man/man3/BIO_s_file.3
@@ -1,4 +1,4 @@
-.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43)
+.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)
.\"
.\" Standard preamble:
.\" ========================================================================
@@ -68,8 +68,6 @@
. \}
.\}
.rr rF
-.\"
-.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear. Run. Save yourself. No user-serviceable parts.
. \" fudge factors for nroff and troff
.if n \{\
@@ -132,14 +130,16 @@
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
-.IX Title "BIO_S_FILE 3"
-.TH BIO_S_FILE 3 "2022-05-03" "1.1.1o" "OpenSSL"
+.IX Title "BIO_S_FILE 3ossl"
+.TH BIO_S_FILE 3ossl "2023-09-19" "3.0.11" "OpenSSL"
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
-BIO_s_file, BIO_new_file, BIO_new_fp, BIO_set_fp, BIO_get_fp, BIO_read_filename, BIO_write_filename, BIO_append_filename, BIO_rw_filename \- FILE bio
+BIO_s_file, BIO_new_file, BIO_new_fp, BIO_set_fp, BIO_get_fp,
+BIO_read_filename, BIO_write_filename, BIO_append_filename,
+BIO_rw_filename \- FILE bio
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
@@ -152,10 +152,10 @@ BIO_s_file, BIO_new_file, BIO_new_fp, BIO_set_fp, BIO_get_fp, BIO_read_filename,
\& BIO_set_fp(BIO *b, FILE *fp, int flags);
\& BIO_get_fp(BIO *b, FILE **fpp);
\&
-\& int BIO_read_filename(BIO *b, char *name)
-\& int BIO_write_filename(BIO *b, char *name)
-\& int BIO_append_filename(BIO *b, char *name)
-\& int BIO_rw_filename(BIO *b, char *name)
+\& int BIO_read_filename(BIO *b, char *name);
+\& int BIO_write_filename(BIO *b, char *name);
+\& int BIO_append_filename(BIO *b, char *name);
+\& int BIO_rw_filename(BIO *b, char *name);
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
@@ -220,16 +220,15 @@ lingual environment, encode filenames in \s-1UTF\-8.\s0
\&\fBBIO_new_file()\fR and \fBBIO_new_fp()\fR return a file \s-1BIO\s0 or \s-1NULL\s0 if an error
occurred.
.PP
-\&\fBBIO_set_fp()\fR and \fBBIO_get_fp()\fR return 1 for success or 0 for failure
+\&\fBBIO_set_fp()\fR and \fBBIO_get_fp()\fR return 1 for success or <=0 for failure
(although the current implementation never return 0).
.PP
-\&\fBBIO_seek()\fR returns the same value as the underlying \fBfseek()\fR function:
-0 for success or \-1 for failure.
+\&\fBBIO_seek()\fR returns 0 for success or negative values for failure.
.PP
-\&\fBBIO_tell()\fR returns the current file position.
+\&\fBBIO_tell()\fR returns the current file position or negative values for failure.
.PP
\&\fBBIO_read_filename()\fR, \fBBIO_write_filename()\fR, \fBBIO_append_filename()\fR and
-\&\fBBIO_rw_filename()\fR return 1 for success or 0 for failure.
+\&\fBBIO_rw_filename()\fR return 1 for success or <=0 for failure.
.SH "EXAMPLES"
.IX Header "EXAMPLES"
File \s-1BIO\s0 \*(L"hello world\*(R":
@@ -249,7 +248,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\en");
.Ve
@@ -274,7 +273,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\en");
\& BIO_free(out);
@@ -295,9 +294,9 @@ occurred this differs from other types of \s-1BIO\s0 which will typically return
\&\fBBIO_set_close\fR\|(3), \fBBIO_get_close\fR\|(3)
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
-Copyright 2000\-2020 The OpenSSL Project Authors. All Rights Reserved.
+Copyright 2000\-2021 The OpenSSL Project Authors. All Rights Reserved.
.PP
-Licensed under the OpenSSL license (the \*(L"License\*(R"). You may not use
+Licensed under the Apache License 2.0 (the \*(L"License\*(R"). You may not use
this file except in compliance with the License. You can obtain a copy
in the file \s-1LICENSE\s0 in the source distribution or at
<https://www.openssl.org/source/license.html>.