docs/latex/wx/ftp.tex

   1 \section{\class{wxFTP}}\label{wxftp}
   2
   3 \wxheading{Derived from}
   4
   5 \helpref{wxProtocol}{wxprotocol}
   6
   7 \wxheading{See also}
   8
   9 \helpref{wxSocketBase}{wxsocketbase}
  10
  11 % ----------------------------------------------------------------------------
  12 % Members
  13 % ----------------------------------------------------------------------------
  14
  15 \latexignore{\rtfignore{\membersection{Members}}}
  16
  17 \membersection{wxFTP::SendCommand}
  18
  19 \func{bool}{SendCommand}{\param{const wxString\&}{command}, \param{char }{ret}}
  20
  21 Send the specified \it{command} to the FTP server. \it{ret} specifies
  22 the expected result.
  23
  24 \wxheading{Return value}
  25
  26 TRUE, if the command has been sent successfully, else FALSE.
  27
  28 % ----------------------------------------------------------------------------
  29
  30 \membersection{wxFTP::GetLastResult}
  31
  32 \func{const wxString\&}{GetLastResult}{\void}
  33
  34 Returns the last command result.
  35
  36 % ----------------------------------------------------------------------------
  37
  38 \membersection{wxFTP::ChDir}
  39
  40 \func{bool}{ChDir}{\param{const wxString\&}{dir}}
  41
  42 Change the current FTP working directory.
  43 Returns TRUE, if successful.
  44
  45 \membersection{wxFTP::MkDir}
  46
  47 \func{bool}{MkDir}{\param{const wxString\&}{dir}}
  48
  49 Create the specified directory in the current FTP working directory.
  50 Returns TRUE, if successful.
  51
  52 \membersection{wxFTP::RmDir}
  53
  54 \func{bool}{RmDir}{\param{const wxString\&}{dir}}
  55
  56 Remove the specified directory from the current FTP working directory.
  57 Returns TRUE, if successful.
  58
  59 \membersection{wxFTP::Pwd}
  60
  61 \func{wxString}{Pwd}{\void}
  62
  63 Returns the current FTP working directory.
  64
  65 % ----------------------------------------------------------------------------
  66
  67 \membersection{wxFTP::Rename}
  68
  69 \func{bool}{Rename}{\param{const wxString\&}{src}, \param{const wxString\&}{dst}}
  70
  71 Rename the specified \it{src} element into \it{dst}
  72 Returns TRUE, if successful.
  73
  74 % ----------------------------------------------------------------------------
  75
  76 \membersection{wxFTP::RmFile}
  77
  78 \func{bool}{RmFile}{\param{const wxString\&}{path}}
  79
  80 Delete the file specified by \it{path}.
  81 Returns TRUE, if successful.
  82
  83 % ----------------------------------------------------------------------------
  84
  85 \membersection{wxFTP::GetOutputStream}
  86
  87 \func{wxOutputStream *}{GetOutputStream}{\param{const wxString\&}{file}}
  88
  89 Initializes an output stream to the specified \it{file}. The returned
  90 stream has all but seek functionality of wxStreams. When the user finishes
  91 writing data, he has to delete the stream to close it.
  92
  93 \wxheading{Return value}
  94
  95 An initialized write-only stream.