secure/lib/libcrypto/man/BIO_s_file.3

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