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{SeekO()}{wxoutputstreamseeko}
  12 can 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{wxOutputStream}{wxoutputstream}\\
  18 \helpref{wxStreamBase}{wxstreambase}
  19
  20 \wxheading{Include files}
  21
  22 <wx/wfstream.h>
  23
  24 \wxheading{Library}
  25
  26 \helpref{wxBase}{librarieslist}
  27
  28 \wxheading{See also}
  29
  30 \helpref{wxBufferedOutputStream}{wxbufferedoutputstream}, \helpref{wxFileInputStream}{wxfileinputstream}, \helpref{wxFFileInputStream}{wxffileinputstream}
  31
  32 % ----------
  33 % Members
  34 % ----------
  35 \latexignore{\rtfignore{\wxheading{Members}}}
  36
  37 \membersection{wxFileOutputStream::wxFileOutputStream}\label{wxfileoutputstreamctor}
  38
  39 \func{}{wxFileOutputStream}{\param{const wxString\&}{ ofileName}}
  40
  41 Creates a new file with {\it ofilename} name and initializes the stream in
  42 write-only mode.
  43
  44 \func{}{wxFileOutputStream}{\param{wxFile\&}{ file}}
  45
  46 Initializes a file stream in write-only mode using the file I/O object {\it file}.
  47
  48 \func{}{wxFileOutputStream}{\param{int}{ fd}}
  49
  50 Initializes a file stream in write-only mode using the file descriptor {\it fd}.
  51
  52 \membersection{wxFileOutputStream::\destruct{wxFileOutputStream}}\label{wxfileoutputstreamdtor}
  53
  54 \func{}{\destruct{wxFileOutputStream}}{\void}
  55
  56 Destructor.
  57
  58 \membersection{wxFileOutputStream::IsOk}\label{wxfileoutputstreamisok}
  59
  60 \constfunc{bool}{IsOk}{\void}
  61
  62 Returns true if the stream is initialized and ready.
  63