%% Created: ~1997
%% RCS-ID: $Id$
%% Copyright: (c) wxWidgets team
-%% License: wxWidgets license
+%% License: wxWindows license
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\section{\class{wxFTP}}\label{wxftp}
<wx/protocol/ftp.h>
+\wxheading{Library}
+
+\helpref{wxNet}{librarieslist}
+
\wxheading{See also}
\helpref{wxSocketBase}{wxsocketbase}
\latexignore{\rtfignore{\wxheading{Members}}}
-\membersection{wxFTP::wxFTP}
+\membersection{wxFTP::wxFTP}\label{wxftpctor}
\func{}{wxFTP}{\void}
Default constructor.
-\membersection{wxFTP::\destruct{wxFTP}}
+\membersection{wxFTP::\destruct{wxFTP}}\label{wxftpdtor}
\func{}{\destruct{wxFTP}}{\void}
\func{bool}{Abort}{\void}
-Aborts the download currently in process, returns {\tt true} if ok, {\tt false}
-if an error occured.
+Aborts the download currently in process, returns \true if ok, \false
+if an error occurred.
-\membersection{wxFTP::CheckCommand}
+\membersection{wxFTP::CheckCommand}\label{wxftpcheckcommand}
\func{bool}{CheckCommand}{\param{const wxString\&}{ command}, \param{char }{ret}}
character of the return code.
-\membersection{wxFTP::GetLastResult}
+\membersection{wxFTP::GetLastResult}\label{wxftpgetlastresult}
\func{const wxString\&}{GetLastResult}{\void}
% ----------------------------------------------------------------------------
-\membersection{wxFTP::ChDir}
+\membersection{wxFTP::ChDir}\label{wxftpchdir}
\func{bool}{ChDir}{\param{const wxString\&}{ dir}}
Returns true if successful.
-\membersection{wxFTP::MkDir}
+\membersection{wxFTP::MkDir}\label{wxftpmkdir}
\func{bool}{MkDir}{\param{const wxString\&}{ dir}}
Returns true if successful.
-\membersection{wxFTP::RmDir}
+\membersection{wxFTP::RmDir}\label{wxftprmdir}
\func{bool}{RmDir}{\param{const wxString\&}{ dir}}
Returns true if successful.
-\membersection{wxFTP::Pwd}
+\membersection{wxFTP::Pwd}\label{wxftppwd}
\func{wxString}{Pwd}{\void}
% ----------------------------------------------------------------------------
-\membersection{wxFTP::Rename}
+\membersection{wxFTP::Rename}\label{wxftprename}
\func{bool}{Rename}{\param{const wxString\&}{ src}, \param{const wxString\&}{ dst}}
% ----------------------------------------------------------------------------
-\membersection{wxFTP::RmFile}
+\membersection{wxFTP::RmFile}\label{wxftprmfile}
\func{bool}{RmFile}{\param{const wxString\&}{ path}}
% ----------------------------------------------------------------------------
-\membersection{wxFTP::SetAscii}
+\membersection{wxFTP::SetAscii}\label{wxftpsetascii}
\func{bool}{SetAscii}{\void}
Sets the transfer mode to ASCII. It will be used for the next transfer.
-\membersection{wxFTP::SetBinary}
+\membersection{wxFTP::SetBinary}\label{wxftpsetbinary}
\func{bool}{SetBinary}{\void}
Sets the transfer mode to binary (IMAGE). It will be used for the next transfer.
-\membersection{wxFTP::SetPassive}
+\membersection{wxFTP::SetPassive}\label{wxftpsetpassive}
\func{void}{SetPassive}{\param{bool }{pasv}}
active connection.
-\membersection{wxFTP::SetTransferMode}
+\membersection{wxFTP::SetTransferMode}\label{wxftpsettransfermode}
\func{bool}{SetTransferMode}{\param{TransferMode }{mode}}
% ----------------------------------------------------------------------------
-\membersection{wxFTP::SetUser}
+\membersection{wxFTP::SetUser}\label{wxftpsetuser}
\func{void}{SetUser}{\param{const wxString\&}{ user}}
to specify a user and a password.
-\membersection{wxFTP::SetPassword}
+\membersection{wxFTP::SetPassword}\label{wxftpsetpassword}
\func{void}{SetPassword}{\param{const wxString\&}{ passwd}}
\func{bool}{FileExists}{\param{const wxString\&}{ filename}}
-Returns {\tt true} if the given remote file exists, {\tt false} otherwise.
+Returns \true if the given remote file exists, \false otherwise.
\membersection{wxFTP::GetFileSize}\label{wxftpgetfilesize}
% ----------------------------------------------------------------------------
-\membersection{wxFTP::GetOutputStream}
+\membersection{wxFTP::GetOutputStream}\label{wxftpgetoutputstream}
\func{wxOutputStream *}{GetOutputStream}{\param{const wxString\&}{ file}}
% ----------------------------------------------------------------------------
-\membersection{wxFTP::GetInputStream}\label{wxftpgetinput}
+\membersection{wxFTP::GetInputStream}\label{wxftpgetinputstream}
\func{wxInputStream *}{GetInputStream}{\param{const wxString\&}{ path}}
-Creates a new input stream on the the specified path. You can use all but the seek
+Creates a new input stream on the specified path. You can use all but the seek
functionality of wxStream. Seek isn't available on all streams. For example,
-http or ftp streams do not deal with it. Other functions like Tell
+HTTP or FTP streams do not deal with it. Other functions like Tell
are not available for this sort of stream, at present.
You will be notified when the EOF is reached by an error.