docs/latex/wx/ftp.tex

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