%% Modified by:
%% Created: ~1997
%% RCS-ID: $Id$
-%% Copyright: (c) wxWindows team
+%% Copyright: (c) wxWidgets team
%% License: wxWindows license
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
}
ftp.ChDir("/pub");
- wxInputStream *in = ftp.GetInputStream("wxWindows-4.2.0.tar.gz");
+ wxInputStream *in = ftp.GetInputStream("wxWidgets-4.2.0.tar.gz");
if ( !in )
{
wxLogError("Coudln't get file");
}
else
{
- size_t size = in->StreamSize();
+ size_t size = in->GetSize();
char *data = new char[size];
if ( !in->Read(data, size) )
{
\wxheading{Derived from}
-\helpref{wxProtocol}{wxprotocol}
+\helpref{wxProtocol}{wxprotocol}\\
+\helpref{wxSocketClient}{wxsocketclient}\\
+\helpref{wxSocketBase}{wxsocketbase}\\
+\helpref{wxObject}{wxobject}
\wxheading{Include files}
<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}
Destructor will close the connection if connected.
-\membersection{wxFTP::CheckCommand}
+
+\membersection{wxFTP::Abort}\label{wxftpabort}
+
+\func{bool}{Abort}{\void}
+
+Aborts the download currently in process, returns \true if ok, \false
+if an error occurred.
+
+
+\membersection{wxFTP::CheckCommand}\label{wxftpcheckcommand}
\func{bool}{CheckCommand}{\param{const wxString\&}{ command}, \param{char }{ret}}
\wxheading{Return value}
-TRUE if the command has been sent successfully, else FALSE.
+true if the command has been sent successfully, else false.
+
\membersection{wxFTP::SendCommand}\label{wxftpsendcommand}
Send the specified {\it command} to the FTP server and return the first
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}}
Change the current FTP working directory.
-Returns TRUE if successful.
+Returns true if successful.
+
-\membersection{wxFTP::MkDir}
+\membersection{wxFTP::MkDir}\label{wxftpmkdir}
\func{bool}{MkDir}{\param{const wxString\&}{ dir}}
Create the specified directory in the current FTP working directory.
-Returns TRUE if successful.
+Returns true if successful.
-\membersection{wxFTP::RmDir}
+
+\membersection{wxFTP::RmDir}\label{wxftprmdir}
\func{bool}{RmDir}{\param{const wxString\&}{ dir}}
Remove the specified directory from the current FTP working directory.
-Returns TRUE if successful.
+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}}
-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.
% ----------------------------------------------------------------------------
-\membersection{wxFTP::RmFile}
+
+\membersection{wxFTP::RmFile}\label{wxftprmfile}
\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.
% ----------------------------------------------------------------------------
-\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::SetTransferMode}
+
+\membersection{wxFTP::SetPassive}\label{wxftpsetpassive}
+
+\func{void}{SetPassive}{\param{bool }{pasv}}
+
+If \arg{pasv} is \true, passive connection to the FTP server is used. This is
+the default as it works with practically all firewalls. If the server doesn't
+support passive move, you may call this function with \false argument to use
+active connection.
+
+
+\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}}
For example, you can use: "ftp://a\_user:a\_password@a.host:service/a\_directory/a\_file"
to specify a user and a password.
-\membersection{wxFTP::SetPassword}
+
+\membersection{wxFTP::SetPassword}\label{wxftpsetpassword}
\func{void}{SetPassword}{\param{const wxString\&}{ passwd}}
% ----------------------------------------------------------------------------
+
+\membersection{wxFTP::FileExists}\label{wxftpfileexists}
+
+\func{bool}{FileExists}{\param{const wxString\&}{ filename}}
+
+Returns \true if the given remote file exists, \false otherwise.
+
+
+\membersection{wxFTP::GetFileSize}\label{wxftpgetfilesize}
+
+\func{int}{GetFileSize}{\param{const wxString\&}{ filename}}
+
+Returns the file size in bytes or $-1$ if the file doesn't exist or the size
+couldn't be determined. Notice that this size can be approximative size only
+and shouldn't be used for allocating the buffer in which the remote file is
+copied, for example.
+
+
\membersection{wxFTP::GetDirList}\label{wxftpgetdirlist}
\func{bool}{GetDirList}{\param{wxArrayString\& }{files}, \param{const wxString\&}{ wildcard = ""}}
1 file(s) 520 196 bytes
\end{verbatim}
-Return value: TRUE if the file list was successfully retrieved, FALSE
+Return value: true if the file list was successfully retrieved, false
otherwise.
\wxheading{See also}
\helpref{GetFilesList}{wxftpgetfileslist}
+
\membersection{wxFTP::GetFilesList}\label{wxftpgetfileslist}
\func{bool}{GetFilesList}{\param{wxArrayString\& }{files}, \param{const wxString\&}{ wildcard = ""}}
by default). This list always has the same format and contains one full
(including the directory path) file name per line.
-Return value: TRUE if the file list was successfully retrieved, FALSE
+Return value: true if the file list was successfully retrieved, false
otherwise.
% ----------------------------------------------------------------------------
-\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.
ftp.ChDir("a_directory");
in_stream = ftp.GetInputStream("a_file_to_get");
- data = new char[in_stream->StreamSize()];
+ data = new char[in_stream->GetSize()];
- in_stream->Read(data, in_stream->StreamSize());
+ in_stream->Read(data, in_stream->GetSize());
if (in_stream->LastError() != wxStream_NOERROR) {
// Do something.
}
projects / wxWidgets.git / blobdiff