\func{bool}{SendCommand}{\param{const wxString\&}{ command}, \param{char }{ret}}
-Send the specified \it{command} to the FTP server. \it{ret} specifies
+Send the specified {\it command} to the FTP server. {\it ret} specifies
the expected result.
\wxheading{Return value}
\func{bool}{Rename}{\param{const wxString\&}{ src}, \param{const wxString\&}{ dst}}
-Rename the specified \it{src} element to \it{dst}. Returns TRUE if successful.
+Rename the specified {\it src} element to {\it dst}. Returns TRUE if successful.
% ----------------------------------------------------------------------------
\func{bool}{RmFile}{\param{const wxString\&}{ path}}
-Delete the file specified by \it{path}. Returns TRUE if successful.
+Delete the file specified by {\it path}. Returns TRUE if successful.
% ----------------------------------------------------------------------------
\func{wxList *}{GetList}{\param{const wxString\&}{ wildcard}}
The GetList function is quite low-level. It returns the list of the files in
-the current directory. The list can be filtered using the \it{wildcard} string.
-If \it{wildcard} is a NULL string, it will return all files in directory.
+the current directory. The list can be filtered using the {\it wildcard} string.
+If {\it wildcard} is a NULL string, it will return all files in directory.
The form of the list can change from one peer system to another. For example,
for a UNIX peer system, it will look like this:
\func{wxOutputStream *}{GetOutputStream}{\param{const wxString\&}{ file}}
-Initializes an output stream to the specified \it{file}. The returned
+Initializes an output stream to the specified {\it file}. The returned
stream has all but the seek functionality of wxStreams. When the user finishes
writing data, he has to delete the stream to close it.
\begin{verbatim}
wxFTP ftp;
- wxInputStream *in\_stream;
+ wxInputStream *in_stream;
char *data;
ftp.Connect("a.host.domain");
- ftp.ChDir("a\_directory");
- in\_stream = ftp.GetInputStream("a\_file\_to\_get");
+ ftp.ChDir("a_directory");
+ in_stream = ftp.GetInputStream("a_file_to_get");
- data = new char[in\_stream->StreamSize()];
+ data = new char[in_stream->StreamSize()];
- in\_stream->Read(data, in\_stream->StreamSize());
- if (in\_stream->LastError() != wxStream\_NOERROR) {
+ in_stream->Read(data, in_stream->StreamSize());
+ if (in_stream->LastError() != wxStream_NOERROR) {
// Do something.
}
- delete in\_stream; /* Close the DATA connection */
+ delete in_stream; /* Close the DATA connection */
ftp.Close(); /* Close the COMMAND connection */
\end{verbatim}