wxWidgets/docs/latex/wx/ftp.tex
Guilhem Lavaux 7f42cff13e * Doc updates
* Fixes about socket, stream core, a superfluous stream.


git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@1670 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
1999-02-10 20:01:06 +00:00

100 lines
2.5 KiB
TeX

\section{\class{wxFTP}}\label{wxftp}
\wxheading{Derived from}
\helpref{wxProtocol}{wxprotocol}
\wxheading{See also}
\helpref{wxSocketBase}{wxsocketbase}
% ----------------------------------------------------------------------------
% Members
% ----------------------------------------------------------------------------
\latexignore{\rtfignore{\membersection{Members}}}
\membersection{wxFTP::SendCommand}
\func{bool}{SendCommand}{\param{const wxString\&}{ command}, \param{char }{ret}}
Send the specified \it{command} to the FTP server. \it{ret} specifies
the expected result.
\wxheading{Return value}
TRUE, if the command has been sent successfully, else FALSE.
% ----------------------------------------------------------------------------
\membersection{wxFTP::GetLastResult}
\func{const wxString\&}{GetLastResult}{\void}
Returns the last command result.
% ----------------------------------------------------------------------------
\membersection{wxFTP::ChDir}
\func{bool}{ChDir}{\param{const wxString\&}{ dir}}
Change the current FTP working directory.
Returns TRUE, if successful.
\membersection{wxFTP::MkDir}
\func{bool}{MkDir}{\param{const wxString\&}{ dir}}
Create the specified directory in the current FTP working directory.
Returns TRUE, if successful.
\membersection{wxFTP::RmDir}
\func{bool}{RmDir}{\param{const wxString\&}{ dir}}
Remove the specified directory from the current FTP working directory.
Returns TRUE, if successful.
\membersection{wxFTP::Pwd}
\func{wxString}{Pwd}{\void}
Returns the current FTP working directory.
% ----------------------------------------------------------------------------
\membersection{wxFTP::Rename}
\func{bool}{Rename}{\param{const wxString\&}{ src}, \param{const wxString\&}{ dst}}
Rename the specified \it{src} element into \it{dst}
Returns TRUE, if successful.
% ----------------------------------------------------------------------------
\membersection{wxFTP::RmFile}
\func{bool}{RmFile}{\param{const wxString\&}{ path}}
Delete the file specified by \it{path}.
Returns TRUE, if successful.
% ----------------------------------------------------------------------------
\membersection{wxFTP::GetOutputStream}
\func{wxOutputStream *}{GetOutputStream}{\param{const wxString\&}{ file}}
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.
\wxheading{Return value}
An initialized write-only stream.
\wxheading{See also}
\helpref{wxOutputStream}{wxoutputstream}