secure/lib/libcrypto/man/BIO_s_file.3

   1 .\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35)
   2 .\"
   3 .\" Standard preamble:
   4 .\" ========================================================================
   5 .de Sp \" Vertical space (when we can't use .PP)
   6 .if t .sp .5v
   7 .if n .sp
   8 ..
   9 .de Vb \" Begin verbatim text
  10 .ft CW
  11 .nf
  12 .ne \\$1
  13 ..
  14 .de Ve \" End verbatim text
  15 .ft R
  16 .fi
  17 ..
  18 .\" Set up some character translations and predefined strings.  \*(-- will
  19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  20 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
  21 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
  22 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
  23 .\" nothing in troff, for use with C<>.
  24 .tr \(*W-
  25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  26 .ie n \{\
  27 .    ds -- \(*W-
  28 .    ds PI pi
  29 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  30 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  31 .    ds L" ""
  32 .    ds R" ""
  33 .    ds C` ""
  34 .    ds C' ""
  35 'br\}
  36 .el\{\
  37 .    ds -- \|\(em\|
  38 .    ds PI \(*p
  39 .    ds L" ``
  40 .    ds R" ''
  41 .    ds C`
  42 .    ds C'
  43 'br\}
  44 .\"
  45 .\" Escape single quotes in literal strings from groff's Unicode transform.
  46 .ie \n(.g .ds Aq \(aq
  47 .el       .ds Aq '
  48 .\"
  49 .\" If the F register is >0, we'll generate index entries on stderr for
  50 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
  51 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  52 .\" output yourself in some meaningful fashion.
  53 .\"
  54 .\" Avoid warning from groff about undefined register 'F'.
  55 .de IX
  56 ..
  57 .if !\nF .nr F 0
  58 .if \nF>0 \{\
  59 .    de IX
  60 .    tm Index:\\$1\t\\n%\t"\\$2"
  61 ..
  62 .    if !\nF==2 \{\
  63 .        nr % 0
  64 .        nr F 2
  65 .    \}
  66 .\}
  67 .\"
  68 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  69 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  70 .    \" fudge factors for nroff and troff
  71 .if n \{\
  72 .    ds #H 0
  73 .    ds #V .8m
  74 .    ds #F .3m
  75 .    ds #[ \f1
  76 .    ds #] \fP
  77 .\}
  78 .if t \{\
  79 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  80 .    ds #V .6m
  81 .    ds #F 0
  82 .    ds #[ \&
  83 .    ds #] \&
  84 .\}
  85 .    \" simple accents for nroff and troff
  86 .if n \{\
  87 .    ds ' \&
  88 .    ds ` \&
  89 .    ds ^ \&
  90 .    ds , \&
  91 .    ds ~ ~
  92 .    ds /
  93 .\}
  94 .if t \{\
  95 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
  96 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
  97 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
  98 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
  99 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 100 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 101 .\}
 102 .    \" troff and (daisy-wheel) nroff accents
 103 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 104 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 105 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 106 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 107 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 108 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 109 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 110 .ds ae a\h'-(\w'a'u*4/10)'e
 111 .ds Ae A\h'-(\w'A'u*4/10)'E
 112 .    \" corrections for vroff
 113 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 114 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 115 .    \" for low resolution devices (crt and lpr)
 116 .if \n(.H>23 .if \n(.V>19 \
 117 \{\
 118 .    ds : e
 119 .    ds 8 ss
 120 .    ds o a
 121 .    ds d- d\h'-1'\(ga
 122 .    ds D- D\h'-1'\(hy
 123 .    ds th \o'bp'
 124 .    ds Th \o'LP'
 125 .    ds ae ae
 126 .    ds Ae AE
 127 .\}
 128 .rm #[ #] #H #V #F C
 129 .\" ========================================================================
 130 .\"
 131 .IX Title "BIO_S_FILE 3"
 132 .TH BIO_S_FILE 3 "2018-09-11" "1.1.1" "OpenSSL"
 133 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 134 .\" way too many mistakes in technical documents.
 135 .if n .ad l
 136 .nh
 137 .SH "NAME"
 138 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
 139 .SH "SYNOPSIS"
 140 .IX Header "SYNOPSIS"
 141 .Vb 1
 142 \& #include <openssl/bio.h>
 143 \&
 144 \& const BIO_METHOD *BIO_s_file(void);
 145 \& BIO *BIO_new_file(const char *filename, const char *mode);
 146 \& BIO *BIO_new_fp(FILE *stream, int flags);
 147 \&
 148 \& BIO_set_fp(BIO *b, FILE *fp, int flags);
 149 \& BIO_get_fp(BIO *b, FILE **fpp);
 150 \&
 151 \& int BIO_read_filename(BIO *b, char *name)
 152 \& int BIO_write_filename(BIO *b, char *name)
 153 \& int BIO_append_filename(BIO *b, char *name)
 154 \& int BIO_rw_filename(BIO *b, char *name)
 155 .Ve
 156 .SH "DESCRIPTION"
 157 .IX Header "DESCRIPTION"
 158 \&\fIBIO_s_file()\fR returns the \s-1BIO\s0 file method. As its name implies it
 159 is a wrapper round the stdio \s-1FILE\s0 structure and it is a
 160 source/sink \s-1BIO.\s0
 161 .PP
 162 Calls to \fIBIO_read_ex()\fR and \fIBIO_write_ex()\fR read and write data to the
 163 underlying stream. \fIBIO_gets()\fR and \fIBIO_puts()\fR are supported on file BIOs.
 164 .PP
 165 \&\fIBIO_flush()\fR on a file \s-1BIO\s0 calls the \fIfflush()\fR function on the wrapped
 166 stream.
 167 .PP
 168 \&\fIBIO_reset()\fR attempts to change the file pointer to the start of file
 169 using fseek(stream, 0, 0).
 170 .PP
 171 \&\fIBIO_seek()\fR sets the file pointer to position \fBofs\fR from start of file
 172 using fseek(stream, ofs, 0).
 173 .PP
 174 \&\fIBIO_eof()\fR calls \fIfeof()\fR.
 175 .PP
 176 Setting the \s-1BIO_CLOSE\s0 flag calls \fIfclose()\fR on the stream when the \s-1BIO\s0
 177 is freed.
 178 .PP
 179 \&\fIBIO_new_file()\fR creates a new file \s-1BIO\s0 with mode \fBmode\fR the meaning
 180 of \fBmode\fR is the same as the stdio function \fIfopen()\fR. The \s-1BIO_CLOSE\s0
 181 flag is set on the returned \s-1BIO.\s0
 182 .PP
 183 \&\fIBIO_new_fp()\fR creates a file \s-1BIO\s0 wrapping \fBstream\fR. Flags can be:
 184 \&\s-1BIO_CLOSE, BIO_NOCLOSE\s0 (the close flag) \s-1BIO_FP_TEXT\s0 (sets the underlying
 185 stream to text mode, default is binary: this only has any effect under
 186 Win32).
 187 .PP
 188 \&\fIBIO_set_fp()\fR sets the fp of a file \s-1BIO\s0 to \fBfp\fR. \fBflags\fR has the same
 189 meaning as in \fIBIO_new_fp()\fR, it is a macro.
 190 .PP
 191 \&\fIBIO_get_fp()\fR retrieves the fp of a file \s-1BIO,\s0 it is a macro.
 192 .PP
 193 \&\fIBIO_seek()\fR is a macro that sets the position pointer to \fBoffset\fR bytes
 194 from the start of file.
 195 .PP
 196 \&\fIBIO_tell()\fR returns the value of the position pointer.
 197 .PP
 198 \&\fIBIO_read_filename()\fR, \fIBIO_write_filename()\fR, \fIBIO_append_filename()\fR and
 199 \&\fIBIO_rw_filename()\fR set the file \s-1BIO\s0 \fBb\fR to use file \fBname\fR for
 200 reading, writing, append or read write respectively.
 201 .SH "NOTES"
 202 .IX Header "NOTES"
 203 When wrapping stdout, stdin or stderr the underlying stream should not
 204 normally be closed so the \s-1BIO_NOCLOSE\s0 flag should be set.
 205 .PP
 206 Because the file \s-1BIO\s0 calls the underlying stdio functions any quirks
 207 in stdio behaviour will be mirrored by the corresponding \s-1BIO.\s0
 208 .PP
 209 On Windows BIO_new_files reserves for the filename argument to be
 210 \&\s-1UTF\-8\s0 encoded. In other words if you have to make it work in multi\-
 211 lingual environment, encode file names in \s-1UTF\-8.\s0
 212 .SH "EXAMPLES"
 213 .IX Header "EXAMPLES"
 214 File \s-1BIO\s0 \*(L"hello world\*(R":
 215 .PP
 216 .Vb 1
 217 \& BIO *bio_out;
 218 \&
 219 \& bio_out = BIO_new_fp(stdout, BIO_NOCLOSE);
 220 \& BIO_printf(bio_out, "Hello World\en");
 221 .Ve
 222 .PP
 223 Alternative technique:
 224 .PP
 225 .Vb 1
 226 \& BIO *bio_out;
 227 \&
 228 \& bio_out = BIO_new(BIO_s_file());
 229 \& if (bio_out == NULL)
 230 \&     /* Error */
 231 \& if (!BIO_set_fp(bio_out, stdout, BIO_NOCLOSE))
 232 \&     /* Error */
 233 \& BIO_printf(bio_out, "Hello World\en");
 234 .Ve
 235 .PP
 236 Write to a file:
 237 .PP
 238 .Vb 1
 239 \& BIO *out;
 240 \&
 241 \& out = BIO_new_file("filename.txt", "w");
 242 \& if (!out)
 243 \&     /* Error */
 244 \& BIO_printf(out, "Hello World\en");
 245 \& BIO_free(out);
 246 .Ve
 247 .PP
 248 Alternative technique:
 249 .PP
 250 .Vb 1
 251 \& BIO *out;
 252 \&
 253 \& out = BIO_new(BIO_s_file());
 254 \& if (out == NULL)
 255 \&     /* Error */
 256 \& if (!BIO_write_filename(out, "filename.txt"))
 257 \&     /* Error */
 258 \& BIO_printf(out, "Hello World\en");
 259 \& BIO_free(out);
 260 .Ve
 261 .SH "RETURN VALUES"
 262 .IX Header "RETURN VALUES"
 263 \&\fIBIO_s_file()\fR returns the file \s-1BIO\s0 method.
 264 .PP
 265 \&\fIBIO_new_file()\fR and \fIBIO_new_fp()\fR return a file \s-1BIO\s0 or \s-1NULL\s0 if an error
 266 occurred.
 267 .PP
 268 \&\fIBIO_set_fp()\fR and \fIBIO_get_fp()\fR return 1 for success or 0 for failure
 269 (although the current implementation never return 0).
 270 .PP
 271 \&\fIBIO_seek()\fR returns the same value as the underlying \fIfseek()\fR function:
 272 0 for success or \-1 for failure.
 273 .PP
 274 \&\fIBIO_tell()\fR returns the current file position.
 275 .PP
 276 \&\fIBIO_read_filename()\fR, \fIBIO_write_filename()\fR, \fIBIO_append_filename()\fR and
 277 \&\fIBIO_rw_filename()\fR return 1 for success or 0 for failure.
 278 .SH "BUGS"
 279 .IX Header "BUGS"
 280 \&\fIBIO_reset()\fR and \fIBIO_seek()\fR are implemented using \fIfseek()\fR on the underlying
 281 stream. The return value for \fIfseek()\fR is 0 for success or \-1 if an error
 282 occurred this differs from other types of \s-1BIO\s0 which will typically return
 283 1 for success and a non positive value if an error occurred.
 284 .SH "SEE ALSO"
 285 .IX Header "SEE ALSO"
 286 \&\fIBIO_seek\fR\|(3), \fIBIO_tell\fR\|(3),
 287 \&\fIBIO_reset\fR\|(3), \fIBIO_flush\fR\|(3),
 288 \&\fIBIO_read_ex\fR\|(3),
 289 \&\fIBIO_write_ex\fR\|(3), \fIBIO_puts\fR\|(3),
 290 \&\fIBIO_gets\fR\|(3), \fIBIO_printf\fR\|(3),
 291 \&\fIBIO_set_close\fR\|(3), \fIBIO_get_close\fR\|(3)
 292 .SH "COPYRIGHT"
 293 .IX Header "COPYRIGHT"
 294 Copyright 2000\-2018 The OpenSSL Project Authors. All Rights Reserved.
 295 .PP
 296 Licensed under the OpenSSL license (the \*(L"License\*(R").  You may not use
 297 this file except in compliance with the License.  You can obtain a copy
 298 in the file \s-1LICENSE\s0 in the source distribution or at
 299 <https://www.openssl.org/source/license.html>.