1% -----------------------------------------------------------------------------
2% wxFFileInputStream
3% -----------------------------------------------------------------------------
4\section{\class{wxFFileInputStream}}\label{wxffileinputstream}
5
6This class represents data read in from a file. There are actually
7two such groups of classes: this one is based on \helpref{wxFFile}{wxffile} 
8whereas \helpref{wxFileInputStream}{wxfileinputstream} is based in
9the \helpref{wxFile}{wxfile} class.
10
11Note that \helpref{SeekI()}{wxinputstreamseeki} 
12can seek beyond the end of the stream (file) and will thus not return 
13{\it wxInvalidOffset} for that.
14
15\wxheading{Derived from}
16
17\helpref{wxInputStream}{wxinputstream}
18
19\wxheading{Include files}
20
21<wx/wfstream.h>
22
23\wxheading{See also}
24
25\helpref{wxBufferedInputStream}{wxbufferedinputstream}, \helpref{wxFFileOutputStream}{wxffileoutputstream}, \helpref{wxFileOutputStream}{wxfileoutputstream}
26
27% ----------
28% Members
29% ----------
30\latexignore{\rtfignore{\wxheading{Members}}}
31
32\membersection{wxFFileInputStream::wxFFileInputStream}\label{wxffileinputstreamctor}
33
34\func{}{wxFFileInputStream}{\param{const wxString\&}{ filename}, \param{const wxChar *}{ mode = "rb"}}
35
36Opens the specified file using its {\it filename} name using the specified mode.
37
38\func{}{wxFFileInputStream}{\param{wxFFile\&}{ file}}
39
40Initializes a file stream in read-only mode using the file I/O object {\it file}.
41
42\func{}{wxFFileInputStream}{\param{FILE *}{ fp}}
43
44Initializes a file stream in read-only mode using the specified file pointer {\it fp}.
45
46\membersection{wxFFileInputStream::\destruct{wxFFileInputStream}}\label{wxffileinputstreamdtor}
47
48\func{}{\destruct{wxFFileInputStream}}{\void}
49
50Destructor.
51
52\membersection{wxFFileInputStream::IsOk}\label{wxffileinputstreamisok}
53
54\constfunc{bool}{IsOk}{\void}
55
56Returns true if the stream is initialized and ready.
57
58% -----------------------------------------------------------------------------
59% wxFFileOutputStream
60% -----------------------------------------------------------------------------
61\section{\class{wxFFileOutputStream}}\label{wxffileoutputstream}
62
63This class represents data written to a file. There are actually
64two such groups of classes: this one is based on \helpref{wxFFile}{wxffile} 
65whereas \helpref{wxFileInputStream}{wxffileinputstream} is based in
66the \helpref{wxFile}{wxfile} class.
67
68Note that \helpref{SeekO()}{wxoutputstreamseeko} 
69can seek beyond the end of the stream (file) and will thus not return 
70{\it wxInvalidOffset} for that.
71
72\wxheading{Derived from}
73
74\helpref{wxOutputStream}{wxoutputstream}
75
76\wxheading{Include files}
77
78<wx/wfstream.h>
79
80\wxheading{See also}
81
82\helpref{wxBufferedOutputStream}{wxbufferedoutputstream}, \helpref{wxFFileInputStream}{wxffileinputstream}, \helpref{wxFileInputStream}{wxfileinputstream}
83
84% ----------
85% Members
86% ----------
87\latexignore{\rtfignore{\wxheading{Members}}}
88
89\membersection{wxFFileOutputStream::wxFFileOutputStream}\label{wxffileoutputstreamctor}
90
91\func{}{wxFFileOutputStream}{\param{const wxString\&}{ filename}, \param{const wxChar *}{ mode="w+b"}}
92
93Opens the file with the given {\it filename} name in the specified mode.
94
95\func{}{wxFFileOutputStream}{\param{wxFFile\&}{ file}}
96
97Initializes a file stream in write-only mode using the file I/O object {\it file}.
98
99\func{}{wxFFileOutputStream}{\param{FILE *}{ fp}}
100
101Initializes a file stream in write-only mode using the file descriptor {\it fp}.
102
103\membersection{wxFFileOutputStream::\destruct{wxFFileOutputStream}}\label{wxffileoutputstreamdtor}
104
105\func{}{\destruct{wxFFileOutputStream}}{\void}
106
107Destructor.
108
109\membersection{wxFFileOutputStream::IsOk}\label{wxffileoutputstreamisok}
110
111\constfunc{bool}{IsOk}{\void}
112
113Returns true if the stream is initialized and ready.
114
115% -----------------------------------------------------------------------------
116% wxFFileStream
117% -----------------------------------------------------------------------------
118\section{\class{wxFFileStream}}\label{wxffilestream}
119
120\wxheading{Derived from}
121
122\helpref{wxFFileOutputStream}{wxffileoutputstream}, \helpref{wxFFileInputStream}{wxffileinputstream}
123
124\wxheading{Include files}
125
126<wx/wfstream.h>
127
128\wxheading{See also}
129
130\helpref{wxStreamBuffer}{wxstreambuffer}
131
132\latexignore{\rtfignore{\wxheading{Members}}}
133
134\membersection{wxFFileStream::wxFFileStream}\label{wxffilestreamctor}
135
136\func{}{wxFFileStream}{\param{const wxString\&}{ iofileName}}
137
138Initializes a new file stream in read-write mode using the specified 
139{\it iofilename} name.
140
141
142