docs/latex/wx/ffilestr.tex

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