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