secure/lib/libcrypto/man/BIO_s_file.3

   1 .rn '' }`
   2 ''' $RCSfile$$Revision$$Date$
   3 '''
   4 ''' $Log$
   5 '''
   6 .de Sh
   7 .br
   8 .if t .Sp
   9 .ne 5
  10 .PP
  11 \fB\\$1\fR
  12 .PP
  13 ..
  14 .de Sp
  15 .if t .sp .5v
  16 .if n .sp
  17 ..
  18 .de Ip
  19 .br
  20 .ie \\n(.$>=3 .ne \\$3
  21 .el .ne 3
  22 .IP "\\$1" \\$2
  23 ..
  24 .de Vb
  25 .ft CW
  26 .nf
  27 .ne \\$1
  28 ..
  29 .de Ve
  30 .ft R
  31
  32 .fi
  33 ..
  34 '''
  35 '''
  36 '''     Set up \*(-- to give an unbreakable dash;
  37 '''     string Tr holds user defined translation string.
  38 '''     Bell System Logo is used as a dummy character.
  39 '''
  40 .tr \(*W-|\(bv\*(Tr
  41 .ie n \{\
  42 .ds -- \(*W-
  43 .ds PI pi
  44 .if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  45 .if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
  46 .ds L" ""
  47 .ds R" ""
  48 '''   \*(M", \*(S", \*(N" and \*(T" are the equivalent of
  49 '''   \*(L" and \*(R", except that they are used on ".xx" lines,
  50 '''   such as .IP and .SH, which do another additional levels of
  51 '''   double-quote interpretation
  52 .ds M" """
  53 .ds S" """
  54 .ds N" """""
  55 .ds T" """""
  56 .ds L' '
  57 .ds R' '
  58 .ds M' '
  59 .ds S' '
  60 .ds N' '
  61 .ds T' '
  62 'br\}
  63 .el\{\
  64 .ds -- \(em\|
  65 .tr \*(Tr
  66 .ds L" ``
  67 .ds R" ''
  68 .ds M" ``
  69 .ds S" ''
  70 .ds N" ``
  71 .ds T" ''
  72 .ds L' `
  73 .ds R' '
  74 .ds M' `
  75 .ds S' '
  76 .ds N' `
  77 .ds T' '
  78 .ds PI \(*p
  79 'br\}
  80 .\"     If the F register is turned on, we'll generate
  81 .\"     index entries out stderr for the following things:
  82 .\"             TH      Title
  83 .\"             SH      Header
  84 .\"             Sh      Subsection
  85 .\"             Ip      Item
  86 .\"             X<>     Xref  (embedded
  87 .\"     Of course, you have to process the output yourself
  88 .\"     in some meaninful fashion.
  89 .if \nF \{
  90 .de IX
  91 .tm Index:\\$1\t\\n%\t"\\$2"
  92 ..
  93 .nr % 0
  94 .rr F
  95 .\}
  96 .TH BIO_s_file 3 "0.9.7d" "2/Sep/2004" "OpenSSL"
  97 .UC
  98 .if n .hy 0
  99 .if n .na
 100 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
 101 .de CQ          \" put $1 in typewriter font
 102 .ft CW
 103 'if n "\c
 104 'if t \\&\\$1\c
 105 'if n \\&\\$1\c
 106 'if n \&"
 107 \\&\\$2 \\$3 \\$4 \\$5 \\$6 \\$7
 108 '.ft R
 109 ..
 110 .\" @(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2
 111 .       \" AM - accent mark definitions
 112 .bd B 3
 113 .       \" fudge factors for nroff and troff
 114 .if n \{\
 115 .       ds #H 0
 116 .       ds #V .8m
 117 .       ds #F .3m
 118 .       ds #[ \f1
 119 .       ds #] \fP
 120 .\}
 121 .if t \{\
 122 .       ds #H ((1u-(\\\\n(.fu%2u))*.13m)
 123 .       ds #V .6m
 124 .       ds #F 0
 125 .       ds #[ \&
 126 .       ds #] \&
 127 .\}
 128 .       \" simple accents for nroff and troff
 129 .if n \{\
 130 .       ds ' \&
 131 .       ds ` \&
 132 .       ds ^ \&
 133 .       ds , \&
 134 .       ds ~ ~
 135 .       ds ? ?
 136 .       ds ! !
 137 .       ds /
 138 .       ds q
 139 .\}
 140 .if t \{\
 141 .       ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
 142 .       ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
 143 .       ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
 144 .       ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
 145 .       ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 146 .       ds ? \s-2c\h'-\w'c'u*7/10'\u\h'\*(#H'\zi\d\s+2\h'\w'c'u*8/10'
 147 .       ds ! \s-2\(or\s+2\h'-\w'\(or'u'\v'-.8m'.\v'.8m'
 148 .       ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 149 .       ds q o\h'-\w'o'u*8/10'\s-4\v'.4m'\z\(*i\v'-.4m'\s+4\h'\w'o'u*8/10'
 150 .\}
 151 .       \" troff and (daisy-wheel) nroff accents
 152 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 153 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 154 .ds v \\k:\h'-(\\n(.wu*9/10-\*(#H)'\v'-\*(#V'\*(#[\s-4v\s0\v'\*(#V'\h'|\\n:u'\*(#]
 155 .ds _ \\k:\h'-(\\n(.wu*9/10-\*(#H+(\*(#F*2/3))'\v'-.4m'\z\(hy\v'.4m'\h'|\\n:u'
 156 .ds . \\k:\h'-(\\n(.wu*8/10)'\v'\*(#V*4/10'\z.\v'-\*(#V*4/10'\h'|\\n:u'
 157 .ds 3 \*(#[\v'.2m'\s-2\&3\s0\v'-.2m'\*(#]
 158 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 159 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 160 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 161 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 162 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 163 .ds ae a\h'-(\w'a'u*4/10)'e
 164 .ds Ae A\h'-(\w'A'u*4/10)'E
 165 .ds oe o\h'-(\w'o'u*4/10)'e
 166 .ds Oe O\h'-(\w'O'u*4/10)'E
 167 .       \" corrections for vroff
 168 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 169 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 170 .       \" for low resolution devices (crt and lpr)
 171 .if \n(.H>23 .if \n(.V>19 \
 172 \{\
 173 .       ds : e
 174 .       ds 8 ss
 175 .       ds v \h'-1'\o'\(aa\(ga'
 176 .       ds _ \h'-1'^
 177 .       ds . \h'-1'.
 178 .       ds 3 3
 179 .       ds o a
 180 .       ds d- d\h'-1'\(ga
 181 .       ds D- D\h'-1'\(hy
 182 .       ds th \o'bp'
 183 .       ds Th \o'LP'
 184 .       ds ae ae
 185 .       ds Ae AE
 186 .       ds oe oe
 187 .       ds Oe OE
 188 .\}
 189 .rm #[ #] #H #V #F C
 190 .SH "NAME"
 191 BIO_s_file, BIO_new_file, BIO_new_fp, BIO_set_fp, BIO_get_fp,
 192 BIO_read_filename, BIO_write_filename, BIO_append_filename,
 193 BIO_rw_filename \- FILE bio
 194 .SH "SYNOPSIS"
 195 .PP
 196 .Vb 1
 197 \& #include <openssl/bio.h>
 198 .Ve
 199 .Vb 3
 200 \& BIO_METHOD *   BIO_s_file(void);
 201 \& BIO *BIO_new_file(const char *filename, const char *mode);
 202 \& BIO *BIO_new_fp(FILE *stream, int flags);
 203 .Ve
 204 .Vb 2
 205 \& BIO_set_fp(BIO *b,FILE *fp, int flags);
 206 \& BIO_get_fp(BIO *b,FILE **fpp);
 207 .Ve
 208 .Vb 4
 209 \& int BIO_read_filename(BIO *b, char *name)
 210 \& int BIO_write_filename(BIO *b, char *name)
 211 \& int BIO_append_filename(BIO *b, char *name)
 212 \& int BIO_rw_filename(BIO *b, char *name)
 213 .Ve
 214 .SH "DESCRIPTION"
 215 \fIBIO_s_file()\fR returns the BIO file method. As its name implies it
 216 is a wrapper round the stdio FILE structure and it is a
 217 source/sink BIO.
 218 .PP
 219 Calls to \fIBIO_read()\fR and \fIBIO_write()\fR read and write data to the
 220 underlying stream. \fIBIO_gets()\fR and \fIBIO_puts()\fR are supported on file BIOs.
 221 .PP
 222 \fIBIO_flush()\fR on a file BIO calls the \fIfflush()\fR function on the wrapped
 223 stream.
 224 .PP
 225 \fIBIO_reset()\fR attempts to change the file pointer to the start of file
 226 using \fIfseek\fR\|(stream, 0, 0).
 227 .PP
 228 \fIBIO_seek()\fR sets the file pointer to position \fBofs\fR from start of file
 229 using \fIfseek\fR\|(stream, ofs, 0).
 230 .PP
 231 \fIBIO_eof()\fR calls \fIfeof()\fR.
 232 .PP
 233 Setting the BIO_CLOSE flag calls \fIfclose()\fR on the stream when the BIO
 234 is freed.
 235 .PP
 236 \fIBIO_new_file()\fR creates a new file BIO with mode \fBmode\fR the meaning
 237 of \fBmode\fR is the same as the stdio function \fIfopen()\fR. The BIO_CLOSE
 238 flag is set on the returned BIO.
 239 .PP
 240 \fIBIO_new_fp()\fR creates a file BIO wrapping \fBstream\fR. Flags can be:
 241 BIO_CLOSE, BIO_NOCLOSE (the close flag) BIO_FP_TEXT (sets the underlying
 242 stream to text mode, default is binary: this only has any effect under
 243 Win32).
 244 .PP
 245 \fIBIO_set_fp()\fR set the fp of a file BIO to \fBfp\fR. \fBflags\fR has the same
 246 meaning as in \fIBIO_new_fp()\fR, it is a macro.
 247 .PP
 248 \fIBIO_get_fp()\fR retrieves the fp of a file BIO, it is a macro.
 249 .PP
 250 \fIBIO_seek()\fR is a macro that sets the position pointer to \fBoffset\fR bytes
 251 from the start of file.
 252 .PP
 253 \fIBIO_tell()\fR returns the value of the position pointer.
 254 .PP
 255 \fIBIO_read_filename()\fR, \fIBIO_write_filename()\fR, \fIBIO_append_filename()\fR and
 256 \fIBIO_rw_filename()\fR set the file BIO \fBb\fR to use file \fBname\fR for
 257 reading, writing, append or read write respectively.
 258 .SH "NOTES"
 259 When wrapping stdout, stdin or stderr the underlying stream should not
 260 normally be closed so the BIO_NOCLOSE flag should be set.
 261 .PP
 262 Because the file BIO calls the underlying stdio functions any quirks
 263 in stdio behaviour will be mirrored by the corresponding BIO.
 264 .SH "EXAMPLES"
 265 File BIO \*(L"hello world":
 266 .PP
 267 .Vb 3
 268 \& BIO *bio_out;
 269 \& bio_out = BIO_new_fp(stdout, BIO_NOCLOSE);
 270 \& BIO_printf(bio_out, "Hello World\en");
 271 .Ve
 272 Alternative technique:
 273 .PP
 274 .Vb 5
 275 \& BIO *bio_out;
 276 \& bio_out = BIO_new(BIO_s_file());
 277 \& if(bio_out == NULL) /* Error ... */
 278 \& if(!BIO_set_fp(bio_out, stdout, BIO_NOCLOSE)) /* Error ... */
 279 \& BIO_printf(bio_out, "Hello World\en");
 280 .Ve
 281 Write to a file:
 282 .PP
 283 .Vb 5
 284 \& BIO *out;
 285 \& out = BIO_new_file("filename.txt", "w");
 286 \& if(!out) /* Error occurred */
 287 \& BIO_printf(out, "Hello World\en");
 288 \& BIO_free(out);
 289 .Ve
 290 Alternative technique:
 291 .PP
 292 .Vb 6
 293 \& BIO *out;
 294 \& out = BIO_new(BIO_s_file());
 295 \& if(out == NULL) /* Error ... */
 296 \& if(!BIO_write_filename(out, "filename.txt")) /* Error ... */
 297 \& BIO_printf(out, "Hello World\en");
 298 \& BIO_free(out);
 299 .Ve
 300 .SH "RETURN VALUES"
 301 \fIBIO_s_file()\fR returns the file BIO method.
 302 .PP
 303 \fIBIO_new_file()\fR and \fIBIO_new_fp()\fR return a file BIO or NULL if an error
 304 occurred.
 305 .PP
 306 \fIBIO_set_fp()\fR and \fIBIO_get_fp()\fR return 1 for success or 0 for failure
 307 (although the current implementation never return 0).
 308 .PP
 309 \fIBIO_seek()\fR returns the same value as the underlying \fIfseek()\fR function:
 310 0 for success or \-1 for failure.
 311 .PP
 312 \fIBIO_tell()\fR returns the current file position.
 313 .PP
 314 \fIBIO_read_filename()\fR, \fIBIO_write_filename()\fR,  \fIBIO_append_filename()\fR and
 315 \fIBIO_rw_filename()\fR return 1 for success or 0 for failure.
 316 .SH "BUGS"
 317 \fIBIO_reset()\fR and \fIBIO_seek()\fR are implemented using \fIfseek()\fR on the underlying
 318 stream. The return value for \fIfseek()\fR is 0 for success or \-1 if an error
 319 occurred this differs from other types of BIO which will typically return
 320 1 for success and a non positive value if an error occurred.
 321 .SH "SEE ALSO"
 322 BIO_seek(3), BIO_tell(3),
 323 BIO_reset(3), BIO_flush(3),
 324 BIO_read(3),
 325 BIO_write(3), BIO_puts(3),
 326 BIO_gets(3), BIO_printf(3),
 327 BIO_set_close(3), BIO_get_close(3)
 328
 329 .rn }` ''
 330 .IX Title "BIO_s_file 3"
 331 .IX Name "BIO_s_file, BIO_new_file, BIO_new_fp, BIO_set_fp, BIO_get_fp,
 332 BIO_read_filename, BIO_write_filename, BIO_append_filename,
 333 BIO_rw_filename - FILE bio"
 334
 335 .IX Header "NAME"
 336
 337 .IX Header "SYNOPSIS"
 338
 339 .IX Header "DESCRIPTION"
 340
 341 .IX Header "NOTES"
 342
 343 .IX Header "EXAMPLES"
 344
 345 .IX Header "RETURN VALUES"
 346
 347 .IX Header "BUGS"
 348
 349 .IX Header "SEE ALSO"
 350