docs/latex/wx/strmfile.tex

   1 % -----------------------------------------------------------------------------
   2 % wxFileInputStream
   3 % -----------------------------------------------------------------------------
   4 \section{\class{wxFileInputStream}}\label{wxfileinputstream}
   5
   6 \wxheading{Derived from}
   7
   8 \helpref{wxInputStream}{wxinputstream}
   9
  10 \wxheading{Include files}
  11
  12 <wx/wfstream.h>
  13
  14 \wxheading{See also}
  15
  16 \helpref{wxStreamBuffer}{wxstreamBuffer}
  17
  18 % ----------
  19 % Members
  20 % ----------
  21 \latexignore{\rtfignore{\wxheading{Members}}}
  22
  23 \membersection{wxFileInputStream::wxFileInputStream}
  24
  25 \func{}{wxFileInputStream}{\param{const wxString\&}{ ifileName}}
  26
  27 Opens the specified file using its \it{ifilename} name in read-only mode.
  28
  29 \func{}{wxFileInputStream}{\param{wxFile\&}{ file}}
  30
  31 Initializes a file stream in read-only mode using the file I/O object \it{file}.
  32
  33 \func{}{wxFileInputStream}{\param{int}{ fd}}
  34
  35 Initializes a file stream in read-only mode using the specified file descriptor.
  36
  37 \membersection{wxFileInputStream::\destruct{wxFileInputStream}}
  38
  39 \func{}{\destruct{wxFileInputStream}}{\void}
  40
  41 Destructor.
  42
  43 \membersection{wxFileInputStream::Ok}
  44
  45 \constfunc{bool}{Ok}{\void}
  46
  47 Returns TRUE if the stream is initialized and ready.
  48
  49 % -----------------------------------------------------------------------------
  50 % wxFileOutputStream
  51 % -----------------------------------------------------------------------------
  52 \section{\class{wxFileOutputStream}}\label{wxfileoutputstream}
  53
  54 \wxheading{Derived from}
  55
  56 \helpref{wxOutputStream}{wxoutputstream}
  57
  58 \wxheading{Include files}
  59
  60 <wx/wfstream.h>
  61
  62 \wxheading{See also}
  63
  64 \helpref{wxStreamBuffer}{wxstreamBuffer}
  65
  66 % ----------
  67 % Members
  68 % ----------
  69 \latexignore{\rtfignore{\wxheading{Members}}}
  70
  71 \membersection{wxFileOutputStream::wxFileOutputStream}
  72
  73 \func{}{wxFileOutputStream}{\param{const wxString\&}{ ofileName}}
  74
  75 Creates a new file with \it{ofilename} name and initializes the stream in
  76 write-only mode.
  77
  78 \func{}{wxFileOutputStream}{\param{wxFile\&}{ file}}
  79
  80 Initializes a file stream in write-only mode using the file I/O object \it{file}.
  81
  82 \func{}{wxFileOutputStream}{\param{int}{ fd}}
  83
  84 Initializes a file stream in write-only mode using the file descriptor \it{fd}.
  85
  86 \membersection{wxFileOutputStream::\destruct{wxFileOutputStream}}
  87
  88 \func{}{\destruct{wxFileOutputStream}}{\void}
  89
  90 Destructor.
  91
  92 \membersection{wxFileOutputStream::Ok}
  93
  94 \constfunc{bool}{Ok}{\void}
  95
  96 Returns TRUE if the stream is initialized and ready.
  97
  98 % -----------------------------------------------------------------------------
  99 % wxFileStream
 100 % -----------------------------------------------------------------------------
 101 \section{\class{wxFileStream}}
 102
 103 \wxheading{Derived from}
 104
 105 \helpref{wxFileOutputStream}{wxFileOutputStream}, \helpref{wxFileInputStream}{wxfileinputstream}
 106
 107 \wxheading{Include files}
 108
 109 <wx/wfstream.h>
 110
 111 \wxheading{See also}
 112
 113 \helpref{wxStreamBuffer}{wxstreamBuffer}
 114
 115 \latexignore{\rtfignore{\wxheading{Members}}}
 116
 117 \membersection{wxFileStream::wxFileStream}
 118
 119 \func{}{wxFileStream}{\param{const wxString\&}{ iofileName}}
 120
 121 Initializes a new file stream in read-write mode using the specified
 122 \it{iofilename} name.
 123