MF_BYCOMMAND is zero so don't try to test it

[wxWidgets.git] / docs / latex / wx / ftp.tex

diff --git a/docs/latex/wx/ftp.tex b/docs/latex/wx/ftp.tex
index b9a835791d8c0385e92a9942934810d99983bf0f..015bb590ed1f06b6eca720fc6ab9493db5b28545 100644 (file)
--- a/docs/latex/wx/ftp.tex
+++ b/docs/latex/wx/ftp.tex
@@ -6,7 +6,7 @@
 %% Created:     ~1997
 %% RCS-ID:      $Id$
 %% Copyright:   (c) wxWidgets team
 %% Created:     ~1997
 %% RCS-ID:      $Id$
 %% Copyright:   (c) wxWidgets team

-%% License:     wxWidgets license
+%% License:     wxWindows license

 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
 \section{\class{wxFTP}}\label{wxftp}
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
 \section{\class{wxFTP}}\label{wxftp}


@@ -103,18 +103,21 @@ enum TransferMode
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 

-\membersection{wxFTP::wxFTP}
+
+\membersection{wxFTP::wxFTP}\label{wxftpctor}

 
 \func{}{wxFTP}{\void}
 
 Default constructor.
 
 
 \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.
 
 
 \func{}{\destruct{wxFTP}}{\void}
 
 Destructor will close the connection if connected.
 

+

 \membersection{wxFTP::Abort}\label{wxftpabort}
 
 \func{bool}{Abort}{\void}
 \membersection{wxFTP::Abort}\label{wxftpabort}
 
 \func{bool}{Abort}{\void}


@@ -122,7 +125,8 @@ Destructor will close the connection if connected.
 Aborts the download currently in process, returns {\tt true} if ok, {\tt false} 
 if an error occured.
 
 Aborts the download currently in process, returns {\tt true} if ok, {\tt false} 
 if an error occured.
 

-\membersection{wxFTP::CheckCommand}
+
+\membersection{wxFTP::CheckCommand}\label{wxftpcheckcommand}

 
 \func{bool}{CheckCommand}{\param{const wxString\&}{ command}, \param{char }{ret}}
 
 
 \func{bool}{CheckCommand}{\param{const wxString\&}{ command}, \param{char }{ret}}
 


@@ -133,6 +137,7 @@ the expected result.
 
 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}}
 \membersection{wxFTP::SendCommand}\label{wxftpsendcommand}
 
 \func{char}{SendCommand}{\param{const wxString\&}{ command}}


@@ -140,7 +145,8 @@ true if the command has been sent successfully, else false.
 Send the specified {\it command} to the FTP server and return the first
 character of the return code.
 
 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}
 
 
 \func{const wxString\&}{GetLastResult}{\void}
 


@@ -149,28 +155,32 @@ command.
 
 % ----------------------------------------------------------------------------
 
 
 % ----------------------------------------------------------------------------
 

-\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.
 
 
 \func{bool}{ChDir}{\param{const wxString\&}{ dir}}
 
 Change the current FTP working directory.
 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.
 
 
 \func{bool}{MkDir}{\param{const wxString\&}{ dir}}
 
 Create the specified directory in the current FTP working directory.
 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.
 
 
 \func{bool}{RmDir}{\param{const wxString\&}{ dir}}
 
 Remove the specified directory from the current FTP working directory.
 Returns true if successful.
 

-\membersection{wxFTP::Pwd}
+
+\membersection{wxFTP::Pwd}\label{wxftppwd}

 
 \func{wxString}{Pwd}{\void}
 
 
 \func{wxString}{Pwd}{\void}
 


@@ -178,7 +188,8 @@ Returns the current FTP working directory.
 
 % ----------------------------------------------------------------------------
 
 
 % ----------------------------------------------------------------------------
 

-\membersection{wxFTP::Rename}
+
+\membersection{wxFTP::Rename}\label{wxftprename}

 
 \func{bool}{Rename}{\param{const wxString\&}{ src}, \param{const wxString\&}{ dst}}
 
 
 \func{bool}{Rename}{\param{const wxString\&}{ src}, \param{const wxString\&}{ dst}}
 


@@ -186,7 +197,8 @@ 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}}
 
 
 \func{bool}{RmFile}{\param{const wxString\&}{ path}}
 


@@ -194,19 +206,32 @@ 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.
 
 
 \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.
 
 
 \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}}
 
 
 \func{bool}{SetTransferMode}{\param{TransferMode }{mode}}
 


@@ -217,7 +242,8 @@ If this function is never called, binary transfer mode is used by default.
 
 % ----------------------------------------------------------------------------
 
 
 % ----------------------------------------------------------------------------
 

-\membersection{wxFTP::SetUser}
+
+\membersection{wxFTP::SetUser}\label{wxftpsetuser}

 
 \func{void}{SetUser}{\param{const wxString\&}{ user}}
 
 
 \func{void}{SetUser}{\param{const wxString\&}{ user}}
 


@@ -233,7 +259,8 @@ This parameter can be included in a URL if you want to use the URL manager.
 For example, you can use: "ftp://a\_user:a\_password@a.host:service/a\_directory/a\_file"
 to specify a user and a password.
 
 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}}
 
 
 \func{void}{SetPassword}{\param{const wxString\&}{ passwd}}
 


@@ -253,12 +280,14 @@ to specify a user and a password.
 
 % ----------------------------------------------------------------------------
 
 
 % ----------------------------------------------------------------------------
 

+

 \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::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}}
 \membersection{wxFTP::GetFileSize}\label{wxftpgetfilesize}
 
 \func{int}{GetFileSize}{\param{const wxString\&}{ filename}}


@@ -268,6 +297,7 @@ 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.
 
 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 = ""}}
 \membersection{wxFTP::GetDirList}\label{wxftpgetdirlist}
 
 \func{bool}{GetDirList}{\param{wxArrayString\& }{files}, \param{const wxString\&}{ wildcard = ""}}


@@ -302,6 +332,7 @@ otherwise.
 
 \helpref{GetFilesList}{wxftpgetfileslist}
 
 
 \helpref{GetFilesList}{wxftpgetfileslist}
 

+

 \membersection{wxFTP::GetFilesList}\label{wxftpgetfileslist}
 
 \func{bool}{GetFilesList}{\param{wxArrayString\& }{files}, \param{const wxString\&}{ wildcard = ""}}
 \membersection{wxFTP::GetFilesList}\label{wxftpgetfileslist}
 
 \func{bool}{GetFilesList}{\param{wxArrayString\& }{files}, \param{const wxString\&}{ wildcard = ""}}


@@ -316,7 +347,8 @@ otherwise.
 
 % ----------------------------------------------------------------------------
 
 
 % ----------------------------------------------------------------------------
 

-\membersection{wxFTP::GetOutputStream}
+
+\membersection{wxFTP::GetOutputStream}\label{wxftpgetoutputstream}

 
 \func{wxOutputStream *}{GetOutputStream}{\param{const wxString\&}{ file}}
 
 
 \func{wxOutputStream *}{GetOutputStream}{\param{const wxString\&}{ file}}
 


@@ -334,7 +366,8 @@ An initialized write-only stream.
 
 % ----------------------------------------------------------------------------
 
 
 % ----------------------------------------------------------------------------
 

-\membersection{wxFTP::GetInputStream}\label{wxftpgetinput}
+
+\membersection{wxFTP::GetInputStream}\label{wxftpgetinputstream}

 
 \func{wxInputStream *}{GetInputStream}{\param{const wxString\&}{ path}}
 
 
 \func{wxInputStream *}{GetInputStream}{\param{const wxString\&}{ path}}