]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/ftp.tex
InsertItems() documented
[wxWidgets.git] / docs / latex / wx / ftp.tex
index 11fce8e93134d77f464d193426100538d8d44725..c484054d96f039878327aa2a66ccf7a22aa22572 100644 (file)
@@ -4,6 +4,10 @@
 
 \helpref{wxProtocol}{wxprotocol}
 
+\wxheading{Include files}
+
+<wx/ftp.h>
+
 \wxheading{See also}
 
 \helpref{wxSocketBase}{wxsocketbase}
@@ -16,7 +20,7 @@
 
 \membersection{wxFTP::SendCommand}
 
-\func{bool}{SendCommand}{\param{const wxString\&}{command}, \param{char }{ret}}
+\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.
@@ -37,21 +41,21 @@ Returns the last command result.
 
 \membersection{wxFTP::ChDir}
 
-\func{bool}{ChDir}{\param{const wxString\&}{dir}}
+\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}}
+\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}}
+\func{bool}{RmDir}{\param{const wxString\&}{ dir}}
 
 Remove the specified directory from the current FTP working directory.
 Returns TRUE, if successful.
@@ -66,7 +70,7 @@ Returns the current FTP working directory.
 
 \membersection{wxFTP::Rename}
 
-\func{bool}{Rename}{\param{const wxString\&}{src}, \param{const wxString\&}{dst}}
+\func{bool}{Rename}{\param{const wxString\&}{ src}, \param{const wxString\&}{ dst}}
 
 Rename the specified \it{src} element into \it{dst}
 Returns TRUE, if successful.
@@ -75,7 +79,7 @@ Returns TRUE, if successful.
 
 \membersection{wxFTP::RmFile}
 
-\func{bool}{RmFile}{\param{const wxString\&}{path}}
+\func{bool}{RmFile}{\param{const wxString\&}{ path}}
 
 Delete the file specified by \it{path}.
 Returns TRUE, if successful.
@@ -84,12 +88,17 @@ Returns TRUE, if successful.
 
 \membersection{wxFTP::GetOutputStream}
 
-\func{wxOutputStream *}{GetOutputStream}{\param{const wxString\&}{file}}
+\func{wxOutputStream *}{GetOutputStream}{\param{const wxString\&}{ file}}
 
 Initializes an output stream to the specified \it{file}. The returned
-stream has all but seek functionality of wxStreams. When the user finishes
+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}
+