docs/latex/wx/fileostr.tex

   1 % -----------------------------------------------------------------------------
   2 % wxFileOutputStream
   3 % -----------------------------------------------------------------------------
   4 \section{\class{wxFileOutputStream}}\label{wxfileoutputstream}
   5
   6 This class represents data written to a file. There are actually
   7 two such groups of classes: this one is based on \helpref{wxFile}{wxfile}
   8 whereas \helpref{wxFFileInputStream}{wxffileinputstream} is based in
   9 the \helpref{wxFFile}{wxffile} 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{SeekO()}{wxoutputstreamseeko}
  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{wxOutputStream}{wxoutputstream}
  25
  26 \wxheading{Include files}
  27
  28 <wx/wfstream.h>
  29
  30 \wxheading{See also}
  31
  32 \helpref{wxBufferedOutputStream}{wxbufferedoutputstream}, \helpref{wxFileInputStream}{wxfileinputstream}, \helpref{wxFFileInputStream}{wxffileinputstream}
  33
  34 % ----------
  35 % Members
  36 % ----------
  37 \latexignore{\rtfignore{\wxheading{Members}}}
  38
  39 \membersection{wxFileOutputStream::wxFileOutputStream}
  40
  41 \func{}{wxFileOutputStream}{\param{const wxString\&}{ ofileName}}
  42
  43 Creates a new file with {\it ofilename} name and initializes the stream in
  44 write-only mode.
  45
  46 \func{}{wxFileOutputStream}{\param{wxFile\&}{ file}}
  47
  48 Initializes a file stream in write-only mode using the file I/O object {\it file}.
  49
  50 \func{}{wxFileOutputStream}{\param{int}{ fd}}
  51
  52 Initializes a file stream in write-only mode using the file descriptor {\it fd}.
  53
  54 \membersection{wxFileOutputStream::\destruct{wxFileOutputStream}}
  55
  56 \func{}{\destruct{wxFileOutputStream}}{\void}
  57
  58 Destructor.
  59
  60 \membersection{wxFileOutputStream::Ok}
  61
  62 \constfunc{bool}{Ok}{\void}
  63
  64 Returns true if the stream is initialized and ready.
  65