fa482912e4
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@6718 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
301 lines
9.5 KiB
TeX
301 lines
9.5 KiB
TeX
% -----------------------------------------------------------------------------
|
|
% wxFileInputStream
|
|
% -----------------------------------------------------------------------------
|
|
\section{\class{wxFileInputStream}}\label{wxfileinputstream}
|
|
|
|
This class represents data read in from a file. There are actually
|
|
two such groups of classes: this one is based on \helpref{wxFile}{wxfile}
|
|
whereas \helpref{wxFFileInputStream}{wxffileinputstream} is based in
|
|
the \helpref{wxFFile}{wxffile} class.
|
|
|
|
Note that \helpref{wxFile}{wxfile} and \helpref{wxFFile}{wxffile} differ
|
|
in one aspect, namely when to report that the end of the file has been
|
|
reached. This is documented in \helpref{wxFile::Eof}{wxfileeof} and
|
|
\helpref{wxFFile::Eof}{wxffileeof} and the behaviour of the stream
|
|
classes reflects this difference, i.e. wxFileInputStream will report
|
|
wxSTREAM\_EOF after having read the last byte whereas wxFFileInputStream
|
|
will report wxSTREAM\_EOF after trying to read {\it past} the last byte.
|
|
|
|
\wxheading{Derived from}
|
|
|
|
\helpref{wxInputStream}{wxinputstream}
|
|
|
|
\wxheading{Include files}
|
|
|
|
<wx/wfstream.h>
|
|
|
|
\wxheading{See also}
|
|
|
|
\helpref{wxBufferedInputStream}{wxbufferedinputstream}, \helpref{wxFileOutputStream}{wxfileoutputstream}, \helpref{wxFFileOutputStream}{wxffileoutputstream}
|
|
|
|
% ----------
|
|
% Members
|
|
% ----------
|
|
\latexignore{\rtfignore{\wxheading{Members}}}
|
|
|
|
\membersection{wxFileInputStream::wxFileInputStream}
|
|
|
|
\func{}{wxFileInputStream}{\param{const wxString\&}{ ifileName}}
|
|
|
|
Opens the specified file using its {\it ifilename} name in read-only mode.
|
|
|
|
\func{}{wxFileInputStream}{\param{wxFile\&}{ file}}
|
|
|
|
Initializes a file stream in read-only mode using the file I/O object {\it file}.
|
|
|
|
\func{}{wxFileInputStream}{\param{int}{ fd}}
|
|
|
|
Initializes a file stream in read-only mode using the specified file descriptor.
|
|
|
|
\membersection{wxFileInputStream::\destruct{wxFileInputStream}}
|
|
|
|
\func{}{\destruct{wxFileInputStream}}{\void}
|
|
|
|
Destructor.
|
|
|
|
\membersection{wxFileInputStream::Ok}
|
|
|
|
\constfunc{bool}{Ok}{\void}
|
|
|
|
Returns TRUE if the stream is initialized and ready.
|
|
|
|
% -----------------------------------------------------------------------------
|
|
% wxFileOutputStream
|
|
% -----------------------------------------------------------------------------
|
|
\section{\class{wxFileOutputStream}}\label{wxfileoutputstream}
|
|
|
|
This class represents data written to a file. There are actually
|
|
two such groups of classes: this one is based on \helpref{wxFile}{wxfile}
|
|
whereas \helpref{wxFFileInputStream}{wxffileinputstream} is based in
|
|
the \helpref{wxFFile}{wxffile} class.
|
|
|
|
Note that \helpref{wxFile}{wxfile} and \helpref{wxFFile}{wxffile} differ
|
|
in one aspect, namely when to report that the end of the file has been
|
|
reached. This is documented in \helpref{wxFile::Eof}{wxfileeof} and
|
|
\helpref{wxFFile::Eof}{wxffileeof} and the behaviour of the stream
|
|
classes reflects this difference, i.e. wxFileInputStream will report
|
|
wxSTREAM\_EOF after having read the last byte whereas wxFFileInputStream
|
|
will report wxSTREAM\_EOF after trying to read {\it past} the last byte.
|
|
|
|
\wxheading{Derived from}
|
|
|
|
\helpref{wxOutputStream}{wxoutputstream}
|
|
|
|
\wxheading{Include files}
|
|
|
|
<wx/wfstream.h>
|
|
|
|
\wxheading{See also}
|
|
|
|
\helpref{wxBufferedOutputStream}{wxbufferedoutputstream}, \helpref{wxFileInputStream}{wxfileinputstream}, \helpref{wxFFileInputStream}{wxffileinputstream}
|
|
|
|
% ----------
|
|
% Members
|
|
% ----------
|
|
\latexignore{\rtfignore{\wxheading{Members}}}
|
|
|
|
\membersection{wxFileOutputStream::wxFileOutputStream}
|
|
|
|
\func{}{wxFileOutputStream}{\param{const wxString\&}{ ofileName}}
|
|
|
|
Creates a new file with {\it ofilename} name and initializes the stream in
|
|
write-only mode.
|
|
|
|
\func{}{wxFileOutputStream}{\param{wxFile\&}{ file}}
|
|
|
|
Initializes a file stream in write-only mode using the file I/O object {\it file}.
|
|
|
|
\func{}{wxFileOutputStream}{\param{int}{ fd}}
|
|
|
|
Initializes a file stream in write-only mode using the file descriptor {\it fd}.
|
|
|
|
\membersection{wxFileOutputStream::\destruct{wxFileOutputStream}}
|
|
|
|
\func{}{\destruct{wxFileOutputStream}}{\void}
|
|
|
|
Destructor.
|
|
|
|
\membersection{wxFileOutputStream::Ok}
|
|
|
|
\constfunc{bool}{Ok}{\void}
|
|
|
|
Returns TRUE if the stream is initialized and ready.
|
|
|
|
% -----------------------------------------------------------------------------
|
|
% wxFileStream
|
|
% -----------------------------------------------------------------------------
|
|
\section{\class{wxFileStream}}
|
|
|
|
\wxheading{Derived from}
|
|
|
|
\helpref{wxFileOutputStream}{wxFileOutputStream}, \helpref{wxFileInputStream}{wxfileinputstream}
|
|
|
|
\wxheading{Include files}
|
|
|
|
<wx/wfstream.h>
|
|
|
|
\wxheading{See also}
|
|
|
|
\helpref{wxStreamBuffer}{wxstreamBuffer}
|
|
|
|
\latexignore{\rtfignore{\wxheading{Members}}}
|
|
|
|
\membersection{wxFileStream::wxFileStream}
|
|
|
|
\func{}{wxFileStream}{\param{const wxString\&}{ iofileName}}
|
|
|
|
Initializes a new file stream in read-write mode using the specified
|
|
{\it iofilename} name.
|
|
|
|
|
|
% -----------------------------------------------------------------------------
|
|
% 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{wxFile}{wxfile} and \helpref{wxFFile}{wxffile} differ
|
|
in one aspect, namely when to report that the end of the file has been
|
|
reached. This is documented in \helpref{wxFile::Eof}{wxfileeof} and
|
|
\helpref{wxFFile::Eof}{wxffileeof} and the behaviour of the stream
|
|
classes reflects this difference, i.e. wxFileInputStream will report
|
|
wxSTREAM\_EOF after having read the last byte whereas wxFFileInputStream
|
|
will report wxSTREAM\_EOF after trying to read {\it past} the last byte.
|
|
|
|
\wxheading{Derived from}
|
|
|
|
\helpref{wxInputStream}{wxinputstream}
|
|
|
|
\wxheading{Include files}
|
|
|
|
<wx/wfstream.h>
|
|
|
|
\wxheading{See also}
|
|
|
|
\helpref{wxBufferedInputStream}{wxbufferedinputstream}, \helpref{wxFFileOutputStream}{wxffileoutputstream}, \helpref{wxFileOutputStream}{wxfileoutputstream}
|
|
|
|
% ----------
|
|
% Members
|
|
% ----------
|
|
\latexignore{\rtfignore{\wxheading{Members}}}
|
|
|
|
\membersection{wxFFileInputStream::wxFFileInputStream}
|
|
|
|
\func{}{wxFFileInputStream}{\param{const wxString\&}{ ifileName}}
|
|
|
|
Opens the specified file using its {\it ifilename} name in read-only 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}}
|
|
|
|
\func{}{\destruct{wxFFileInputStream}}{\void}
|
|
|
|
Destructor.
|
|
|
|
\membersection{wxFFileInputStream::Ok}
|
|
|
|
\constfunc{bool}{Ok}{\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{wxFile}{wxfile} and \helpref{wxFFile}{wxffile} differ
|
|
in one aspect, namely when to report that the end of the file has been
|
|
reached. This is documented in \helpref{wxFile::Eof}{wxfileeof} and
|
|
\helpref{wxFFile::Eof}{wxffileeof} and the behaviour of the stream
|
|
classes reflects this difference, i.e. wxFileInputStream will report
|
|
wxSTREAM\_EOF after having read the last byte whereas wxFFileInputStream
|
|
will report wxSTREAM\_EOF after trying to read {\it past} the last byte.
|
|
|
|
\wxheading{Derived from}
|
|
|
|
\helpref{wxOutputStream}{wxoutputstream}
|
|
|
|
\wxheading{Include files}
|
|
|
|
<wx/wfstream.h>
|
|
|
|
\wxheading{See also}
|
|
|
|
\helpref{wxBufferedOutputStream}{wxbufferedoutputstream}, \helpref{wxFFileInputStream}{wxffileinputstream}, \helpref{wxFileInputStream}{wxfileinputstream}
|
|
|
|
% ----------
|
|
% Members
|
|
% ----------
|
|
\latexignore{\rtfignore{\wxheading{Members}}}
|
|
|
|
\membersection{wxFFileOutputStream::wxFFileOutputStream}
|
|
|
|
\func{}{wxFFileOutputStream}{\param{const wxString\&}{ ofileName}}
|
|
|
|
Creates a new file with {\it ofilename} name and initializes the stream in
|
|
write-only 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}}
|
|
|
|
\func{}{\destruct{wxFFileOutputStream}}{\void}
|
|
|
|
Destructor.
|
|
|
|
\membersection{wxFFileOutputStream::Ok}
|
|
|
|
\constfunc{bool}{Ok}{\void}
|
|
|
|
Returns TRUE if the stream is initialized and ready.
|
|
|
|
% -----------------------------------------------------------------------------
|
|
% wxFFileStream
|
|
% -----------------------------------------------------------------------------
|
|
\section{\class{wxFFileStream}}
|
|
|
|
\wxheading{Derived from}
|
|
|
|
\helpref{wxFFileOutputStream}{wxFFileOutputStream}, \helpref{wxFFileInputStream}{wxffileinputstream}
|
|
|
|
\wxheading{Include files}
|
|
|
|
<wx/wfstream.h>
|
|
|
|
\wxheading{See also}
|
|
|
|
\helpref{wxStreamBuffer}{wxstreamBuffer}
|
|
|
|
\latexignore{\rtfignore{\wxheading{Members}}}
|
|
|
|
\membersection{wxFFileStream::wxFFileStream}
|
|
|
|
\func{}{wxFFileStream}{\param{const wxString\&}{ iofileName}}
|
|
|
|
Initializes a new file stream in read-write mode using the specified
|
|
{\it iofilename} name.
|
|
|
|
|