1 \section{\class{wxFTP
}}\label{wxftp
}
3 \wxheading{Derived from
}
5 \helpref{wxProtocol
}{wxprotocol
}
7 \wxheading{Include files
}
13 \helpref{wxSocketBase
}{wxsocketbase
}
15 % ----------------------------------------------------------------------------
17 % ----------------------------------------------------------------------------
19 \latexignore{\rtfignore{\membersection{Members
}}}
21 \membersection{wxFTP::SendCommand
}
23 \func{bool
}{SendCommand
}{\param{const wxString\&
}{ command
},
\param{char
}{ret
}}
25 Send the specified
\it{command
} to the FTP server.
\it{ret
} specifies
28 \wxheading{Return value
}
30 TRUE, if the command has been sent successfully, else FALSE.
32 % ----------------------------------------------------------------------------
34 \membersection{wxFTP::GetLastResult
}
36 \func{const wxString\&
}{GetLastResult
}{\void}
38 Returns the last command result.
40 % ----------------------------------------------------------------------------
42 \membersection{wxFTP::ChDir
}
44 \func{bool
}{ChDir
}{\param{const wxString\&
}{ dir
}}
46 Change the current FTP working directory.
47 Returns TRUE if successful.
49 \membersection{wxFTP::MkDir
}
51 \func{bool
}{MkDir
}{\param{const wxString\&
}{ dir
}}
53 Create the specified directory in the current FTP working directory.
54 Returns TRUE if successful.
56 \membersection{wxFTP::RmDir
}
58 \func{bool
}{RmDir
}{\param{const wxString\&
}{ dir
}}
60 Remove the specified directory from the current FTP working directory.
61 Returns TRUE if successful.
63 \membersection{wxFTP::Pwd
}
65 \func{wxString
}{Pwd
}{\void}
67 Returns the current FTP working directory.
69 % ----------------------------------------------------------------------------
71 \membersection{wxFTP::Rename
}
73 \func{bool
}{Rename
}{\param{const wxString\&
}{ src
},
\param{const wxString\&
}{ dst
}}
75 Rename the specified
\it{src
} element to
\it{dst
}. Returns TRUE if successful.
77 % ----------------------------------------------------------------------------
79 \membersection{wxFTP::RmFile
}
81 \func{bool
}{RmFile
}{\param{const wxString\&
}{ path
}}
83 Delete the file specified by
\it{path
}. Returns TRUE if successful.
85 % ----------------------------------------------------------------------------
87 \membersection{wxFTP::GetOutputStream
}
89 \func{wxOutputStream *
}{GetOutputStream
}{\param{const wxString\&
}{ file
}}
91 Initializes an output stream to the specified
\it{file
}. The returned
92 stream has all but the seek functionality of wxStreams. When the user finishes
93 writing data, he has to delete the stream to close it.
95 \wxheading{Return value
}
97 An initialized write-only stream.
101 \helpref{wxOutputStream
}{wxoutputstream
}