X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/f6bcfd974ef26faf6f91a62cac09827e09463fd1..654a0fa974e3df189a15592065ee437f42fc7fa4:/docs/latex/wx/ftp.tex diff --git a/docs/latex/wx/ftp.tex b/docs/latex/wx/ftp.tex index e3c5050379..077787ba4e 100644 --- a/docs/latex/wx/ftp.tex +++ b/docs/latex/wx/ftp.tex @@ -1,5 +1,90 @@ +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%% Name: ftp.tex +%% Purpose: wxFTP documentation +%% Author: Guilhem Lavaux, Vadim Zeitlin +%% Modified by: +%% Created: ~1997 +%% RCS-ID: $Id$ +%% Copyright: (c) wxWindows team +%% License: wxWindows license +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + \section{\class{wxFTP}}\label{wxftp} +wxFTP can be used to establish a connection to an FTP server and perform all the +usual operations. Please consult the RFC 959 for more details about the FTP +protocol. + +To use a commands which doesn't involve file transfer (i.e. directory oriented +commands) you just need to call a corresponding member function or use the +generic \helpref{SendCommand}{wxftpsendcommand} method. However to actually +transfer files you just get or give a stream to or from this class and the +actual data are read or written using the usual stream methods. + +Example of using wxFTP for file downloading: + +\begin{verbatim} + wxFTP ftp; + + // if you don't use these lines anonymous login will be used + ftp.SetUser("user"); + ftp.SetPassword("password"); + + if ( !ftp.Connect("ftp.wxwindows.org") ) + { + wxLogError("Couldn't connect"); + return; + } + + ftp.ChDir("/pub"); + wxInputStream *in = ftp.GetInputStream("wxWindows-4.2.0.tar.gz"); + if ( !in ) + { + wxLogError("Coudln't get file"); + } + else + { + size_t size = in->GetSize(); + char *data = new char[size]; + if ( !in->Read(data, size) ) + { + wxLogError("Read error"); + } + else + { + // file data is in the buffer + ... + } + + delete [] data; + delete in; + } +\end{verbatim} + +To upload a file you would do (assuming the connection to the server was opened +successfully): + +\begin{verbatim} + wxOutputStream *out = ftp.GetOutputStream("filename"); + if ( out ) + { + out->Write(...); // your data + delete out; + } +\end{verbatim} + +\wxheading{Constants} + +wxFTP defines constants corresponding to the two supported transfer modes: + +\begin{verbatim} +enum TransferMode +{ + ASCII, + BINARY +}; +\end{verbatim} + \wxheading{Derived from} \helpref{wxProtocol}{wxprotocol} @@ -18,24 +103,49 @@ \latexignore{\rtfignore{\wxheading{Members}}} -\membersection{wxFTP::SendCommand} +\membersection{wxFTP::wxFTP} + +\func{}{wxFTP}{\void} + +Default constructor. + +\membersection{wxFTP::\destruct{wxFTP}} + +\func{}{\destruct{wxFTP}}{\void} + +Destructor will close the connection if connected. -\func{bool}{SendCommand}{\param{const wxString\&}{ command}, \param{char }{ret}} +\membersection{wxFTP::Abort}\label{wxftpabort} + +\func{bool}{Abort}{\void} + +Aborts the download currently in process, returns {\tt true} if ok, {\tt false} +if an error occured. + +\membersection{wxFTP::CheckCommand} + +\func{bool}{CheckCommand}{\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. +true if the command has been sent successfully, else false. -% ---------------------------------------------------------------------------- +\membersection{wxFTP::SendCommand}\label{wxftpsendcommand} + +\func{char}{SendCommand}{\param{const wxString\&}{ command}} + +Send the specified {\it command} to the FTP server and return the first +character of the return code. \membersection{wxFTP::GetLastResult} \func{const wxString\&}{GetLastResult}{\void} -Returns the last command result. +Returns the last command result, i.e. the full server reply for the last +command. % ---------------------------------------------------------------------------- @@ -44,21 +154,21 @@ Returns the last command result. \func{bool}{ChDir}{\param{const wxString\&}{ dir}} Change the current FTP working directory. -Returns TRUE if successful. +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. +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. +Returns true if successful. \membersection{wxFTP::Pwd} @@ -72,7 +182,7 @@ Returns the current FTP working directory. \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. % ---------------------------------------------------------------------------- @@ -80,7 +190,30 @@ 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. + +% ---------------------------------------------------------------------------- + +\membersection{wxFTP::SetAscii} + +\func{bool}{SetAscii}{\void} + +Sets the transfer mode to ASCII. It will be used for the next transfer. + +\membersection{wxFTP::SetBinary} + +\func{bool}{SetBinary}{\void} + +Sets the transfer mode to binary (IMAGE). It will be used for the next transfer. + +\membersection{wxFTP::SetTransferMode} + +\func{bool}{SetTransferMode}{\param{TransferMode }{mode}} + +Sets the transfer mode to the specified one. It will be used for the next +transfer. + +If this function is never called, binary transfer mode is used by default. % ---------------------------------------------------------------------------- @@ -119,9 +252,25 @@ For example, you can use: "ftp://a\_user:a\_password@a.host:service/a\_directory to specify a user and a password. % ---------------------------------------------------------------------------- -\membersection{wxFTP::GetList} -\func{bool}{GetList}{\param{wxArrayString\& }{files}, \param{const wxString\&}{ wildcard = ""}} +\membersection{wxFTP::FileExists}\label{wxftpfileexists} + +\func{bool}{FileExists}{\param{const wxString\&}{ filename}} + +Returns {\tt true} if the given remote file exists, {\tt 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 = ""}} 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. @@ -146,7 +295,23 @@ winamp~1 exe 520196 02-25-1999 19:28 winamp204.exe 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 = ""}} + +This function returns the computer-parsable list of the files in the current +directory (optionally only of the files matching the {\it wildcard}, all files +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 otherwise. % ---------------------------------------------------------------------------- @@ -200,9 +365,9 @@ send new commands without reconnecting. 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. }