wxWidgets/docs/latex/wx/ffilestr.tex

154 lines
4.6 KiB
TeX
Raw Normal View History

% -----------------------------------------------------------------------------
% wxFFileInputStream
% -----------------------------------------------------------------------------
\section{\class{wxFFileInputStream}}\label{wxffileinputstream}
This class represents data read in from a file. There are actually
two such groups of classes: this one is based on \helpref{wxFFile}{wxffile}
whereas \helpref{wxFileInputStream}{wxfileinputstream} is based in
the \helpref{wxFile}{wxfile} class.
Note that \helpref{SeekI()}{wxinputstreamseeki}
can seek beyond the end of the stream (file) and will thus not return
{\it wxInvalidOffset} for that.
\wxheading{Derived from}
\helpref{wxInputStream}{wxinputstream}
\wxheading{Include files}
<wx/wfstream.h>
\wxheading{Library}
\helpref{wxBase}{librarieslist}
\wxheading{See also}
\helpref{wxBufferedInputStream}{wxbufferedinputstream}, \helpref{wxFFileOutputStream}{wxffileoutputstream}, \helpref{wxFileOutputStream}{wxfileoutputstream}
% ----------
% Members
% ----------
\latexignore{\rtfignore{\wxheading{Members}}}
\membersection{wxFFileInputStream::wxFFileInputStream}\label{wxffileinputstreamctor}
\func{}{wxFFileInputStream}{\param{const wxString\&}{ filename}, \param{const wxString\&}{ mode = "rb"}}
Opens the specified file using its {\it filename} name using the specified mode.
\func{}{wxFFileInputStream}{\param{wxFFile\&}{ file}}
Initializes a file stream in read-only mode using the file I/O object {\it file}.
\func{}{wxFFileInputStream}{\param{FILE *}{ fp}}
Initializes a file stream in read-only mode using the specified file pointer {\it fp}.
\membersection{wxFFileInputStream::\destruct{wxFFileInputStream}}\label{wxffileinputstreamdtor}
\func{}{\destruct{wxFFileInputStream}}{\void}
Destructor.
\membersection{wxFFileInputStream::IsOk}\label{wxffileinputstreamisok}
\constfunc{bool}{IsOk}{\void}
Returns true if the stream is initialized and ready.
% -----------------------------------------------------------------------------
% wxFFileOutputStream
% -----------------------------------------------------------------------------
\section{\class{wxFFileOutputStream}}\label{wxffileoutputstream}
This class represents data written to a file. There are actually
two such groups of classes: this one is based on \helpref{wxFFile}{wxffile}
whereas \helpref{wxFileInputStream}{wxffileinputstream} is based in
the \helpref{wxFile}{wxfile} class.
Note that \helpref{SeekO()}{wxoutputstreamseeko}
can seek beyond the end of the stream (file) and will thus not return
{\it wxInvalidOffset} for that.
\wxheading{Derived from}
\helpref{wxOutputStream}{wxoutputstream}
\wxheading{Include files}
<wx/wfstream.h>
\wxheading{Library}
\helpref{wxBase}{librarieslist}
\wxheading{See also}
\helpref{wxBufferedOutputStream}{wxbufferedoutputstream}, \helpref{wxFFileInputStream}{wxffileinputstream}, \helpref{wxFileInputStream}{wxfileinputstream}
% ----------
% Members
% ----------
\latexignore{\rtfignore{\wxheading{Members}}}
\membersection{wxFFileOutputStream::wxFFileOutputStream}\label{wxffileoutputstreamctor}
\func{}{wxFFileOutputStream}{\param{const wxString\&}{ filename}, \param{const wxString\&}{ mode="w+b"}}
Opens the file with the given {\it filename} name in the specified mode.
\func{}{wxFFileOutputStream}{\param{wxFFile\&}{ file}}
Initializes a file stream in write-only mode using the file I/O object {\it file}.
\func{}{wxFFileOutputStream}{\param{FILE *}{ fp}}
Initializes a file stream in write-only mode using the file descriptor {\it fp}.
\membersection{wxFFileOutputStream::\destruct{wxFFileOutputStream}}\label{wxffileoutputstreamdtor}
\func{}{\destruct{wxFFileOutputStream}}{\void}
Destructor.
\membersection{wxFFileOutputStream::IsOk}\label{wxffileoutputstreamisok}
\constfunc{bool}{IsOk}{\void}
Returns true if the stream is initialized and ready.
% -----------------------------------------------------------------------------
% wxFFileStream
% -----------------------------------------------------------------------------
\section{\class{wxFFileStream}}\label{wxffilestream}
\wxheading{Derived from}
\helpref{wxFFileOutputStream}{wxffileoutputstream}, \helpref{wxFFileInputStream}{wxffileinputstream}
\wxheading{Include files}
<wx/wfstream.h>
\wxheading{Library}
\helpref{wxBase}{librarieslist}
\wxheading{See also}
\helpref{wxStreamBuffer}{wxstreambuffer}
\latexignore{\rtfignore{\wxheading{Members}}}
\membersection{wxFFileStream::wxFFileStream}\label{wxffilestreamctor}
\func{}{wxFFileStream}{\param{const wxString\&}{ iofileName}}
Initializes a new file stream in read-write mode using the specified
{\it iofilename} name.