166734b0bcf989e24d28442fde36e1cf2f2ec0c2
[openssl.git] / doc / crypto / BIO_s_file.pod
1 =pod
2
3 =head1 NAME
4
5 BIO_s_file, BIO_new_file, BIO_new_fp, BIO_set_fp, BIO_get_fp,
6 BIO_read_filename, BIO_write_filename, BIO_append_filename,
7 BIO_rw_filename - FILE bio
8
9 =head1 SYNOPSIS
10
11  #include <openssl/bio.h>
12
13  BIO_METHOD *   BIO_s_file(void);
14  BIO *BIO_new_file(const char *filename, const char *mode);
15  BIO *BIO_new_fp(FILE *stream, int flags);
16
17  BIO_set_fp(BIO *b,FILE *fp, int flags);
18  BIO_get_fp(BIO *b,FILE **fpp);
19
20  int BIO_read_filename(BIO *b, char *name)
21  int BIO_write_filename(BIO *b, char *name)
22  int BIO_append_filename(BIO *b, char *name)
23  int BIO_rw_filename(BIO *b, char *name)
24
25 =head1 DESCRIPTION
26
27 BIO_s_file() returns the BIO file method. As its name implies it
28 is a wrapper round the stdio FILE structure and it is a
29 source/sink BIO.
30
31 BIO_new_file() creates a new file BIO with mode B<mode> the meaning
32 of B<mode> is the same as the stdio function fopen(). The BIO_CLOSE
33 flag is set on the returned BIO.
34
35 BIO_new_fp() creates a file BIO wrapping B<stream>. Flags can be:
36 BIO_CLOSE, BIO_NOCLOSE (the close flag) BIO_FP_TEXT (sets the underlying
37 stream to text mode, default is binary: this only has any effect under
38 Win32).
39
40 BIO_set_fp() set the fp of a file BIO to B<fp>. B<flags> has the same
41 meaning as in BIO_new_fp(), it is a macro.
42
43 BIO_get_fp() retrieves the fp of a file BIO, it is a macro.
44
45 BIO_read_filename(), BIO_write_filename(), BIO_append_filename() and
46 BIO_rw_filename() set the file BIO B<b> to use file B<name> for
47 reading, writing, append or read write respectively.
48
49 =head1 NOTES
50
51 Calls to BIO_read() and BIO_write() read and write data to the
52 underlying stream. BIO_gets() and BIO_puts() are supported on file BIOs.
53
54 BIO_flush() on a file BIO calls the fflush() function on the wrapped
55 stream.
56
57 BIO_reset() on a file BIO calls fseek() to reset the position indicator
58 to the start of the file.
59
60 BIO_eof() calls feof().
61
62 Setting the BIO_CLOSE flag calls fclose() on the stream when the BIO
63 is freed.
64
65 When wrapping stdout, stdin or stderr the underlying stream should not
66 normally be closed so the BIO_NOCLOSE flag should be set.
67
68 Because the file BIO calls the underlying stdio functions any quirks
69 in stdio behaviour will be mirrored by the corresponding BIO.
70
71 =head1 EXAMPLES
72
73 File BIO "hello world":
74
75  BIO *bio_out;
76  bio_out = BIO_new_fp(stdout, BIO_NOCLOSE);
77  BIO_printf(bio_out, "Hello World\n");
78
79 Alternative technique:
80
81  BIO *bio_out;
82  bio_out = BIO_new(BIO_s_file());
83  if(bio_out == NULL) /* Error ... */
84  if(!BIO_set_fp(bio_out, stdout, BIO_NOCLOSE)) /* Error ... */
85  BIO_printf(bio_out, "Hello World\n");
86
87 Write to a file:
88
89  BIO *out;
90  out = BIO_new_file("filename.txt", "w");
91  if(!out) /* Error occurred */
92  BIO_printf(out, "Hello World\n");
93  BIO_free(out);
94
95 Alternative technique:
96
97  BIO *out;
98  out = BIO_new(BIO_s_file());
99  if(out == NULL) /* Error ... */
100  if(!BIO_read_filename(out, "filename.txt")) /* Error ... */
101  BIO_printf(out, "Hello World\n");
102  BIO_free(out);
103
104 =head1 RETURN VALUES
105
106 BIO_s_file() returns the file BIO method.
107
108 BIO_new_file() and BIO_new_fp() return a file BIO or NULL if an error
109 occurred.
110
111 BIO_set_fp() and BIO_get_fp() return 1 for success or 0 for failure
112 (although the current implementation never return 0).
113
114 BIO_read_filename(), BIO_write_filename(),  BIO_append_filename() and
115 BIO_rw_filename() return 1 for success or 0 for failure.
116
117 =head1 SEE ALSO
118
119 L<BIO_seek(3)|BIO_seek(3)>, L<BIO_tell(3)|BIO_tell(3)>,
120 L<BIO_reset(3)|BIO_reset(3)>, L<BIO_flush(3)|BIO_flush(3)>,
121 L<BIO_read(3)|BIO_read(3)>,
122 L<BIO_write(3)|BIO_write(3)>, L<BIO_puts(3)|BIO_puts(3)>,
123 L<BIO_gets(3)|BIO_gets(3)>, L<BIO_printf(3)|BIO_printf(3)>,
124 L<BIO_set_close(3)|BIO_set_close(3)>, L<BIO_get_close(3)|BIO_get_close(3)>