X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/721b32e05823b7b7356f9a7a99f7d0af457dc5f3..80d2803f703d1b238f42725504f08266ef02defe:/docs/latex/wx/ftp.tex diff --git a/docs/latex/wx/ftp.tex b/docs/latex/wx/ftp.tex index 99c7f490a8..e3c5050379 100644 --- a/docs/latex/wx/ftp.tex +++ b/docs/latex/wx/ftp.tex @@ -16,18 +16,18 @@ % Members % ---------------------------------------------------------------------------- -\latexignore{\rtfignore{\membersection{Members}}} +\latexignore{\rtfignore{\wxheading{Members}}} \membersection{wxFTP::SendCommand} \func{bool}{SendCommand}{\param{const wxString\&}{ command}, \param{char }{ret}} -Send the specified \it{command} to the FTP server. \it{ret} specifies +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. % ---------------------------------------------------------------------------- @@ -72,7 +72,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 +80,7 @@ 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. % ---------------------------------------------------------------------------- @@ -97,7 +97,7 @@ The default value of the user name is "anonymous". \wxheading{Remark} 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" +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} @@ -115,20 +115,21 @@ user name and the host name of the local machine from the system. \wxheading{Remark} 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" +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::GetList} -\func{wxList *}{GetList}{\param{const wxString\&}{ wildcard}} +\func{bool}{GetList}{\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. -If \it{wildcard} is a NULL string, it will return all files in directory. +the current directory. The list can be filtered using the {\it wildcard} string. +If {\it wildcard} is empty (default), it will return all files in directory. The form of the list can change from one peer system to another. For example, for a UNIX peer system, it will look like this: + \begin{verbatim} -r--r--r-- 1 guilhem lavaux 12738 Jan 16 20:17 cmndata.cpp -r--r--r-- 1 guilhem lavaux 10866 Jan 24 16:41 config.cpp @@ -139,12 +140,14 @@ for a UNIX peer system, it will look like this: \end{verbatim} But on Windows system, it will look like this: + \begin{verbatim} winamp~1 exe 520196 02-25-1999 19:28 winamp204.exe 1 file(s) 520 196 bytes \end{verbatim} -The list is a string list and one node corresponds to a line sent by the peer. +Return value: TRUE if the file list was successfully retrieved, FALSE +otherwise. % ---------------------------------------------------------------------------- @@ -152,7 +155,7 @@ The list is a string list and one node corresponds to a line sent by the peer. \func{wxOutputStream *}{GetOutputStream}{\param{const wxString\&}{ file}} -Initializes an output stream to the specified \it{file}. The returned +Initializes an output stream to the specified {\it file}. The returned stream has all but the seek functionality of wxStreams. When the user finishes writing data, he has to delete the stream to close it. @@ -170,41 +173,41 @@ An initialized write-only stream. \func{wxInputStream *}{GetInputStream}{\param{const wxString\&}{ path}} -Creates a new input stream on the the specified path. You can use all but seek -functionnality of wxStream. Seek isn't available on all stream. For example, -http or ftp streams doesn't deal with it. Other functions like Tell -aren't available for the moment for this sort of stream. +Creates a new input stream on the 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 +are not available for this sort of stream, at present. You will be notified when the EOF is reached by an error. \wxheading{Return value} -Returns NULL if an error occured (it could be a network failure or the fact +Returns NULL if an error occurred (it could be a network failure or the fact that the file doesn't exist). -Returns the initialized stream. You will have to delete it yourself once you -don't use it anymore. The destructor close the DATA stream connection but -will leave the COMMAND stream connection opened. It means that you still -can send new commands without reconnecting. +Returns the initialized stream. You will have to delete it yourself when you +don't need it anymore. The destructor closes the DATA stream connection but +will leave the COMMAND stream connection opened. It means that you can still +send new commands without reconnecting. \wxheading{Example of a standalone connection (without wxURL)} \begin{verbatim} wxFTP ftp; - wxInputStream *in\_stream; + wxInputStream *in_stream; char *data; ftp.Connect("a.host.domain"); - ftp.ChDir("a\_directory"); - in\_stream = ftp.GetInputStream("a\_file\_to\_get"); + ftp.ChDir("a_directory"); + in_stream = ftp.GetInputStream("a_file_to_get"); - data = new char[in\_stream->StreamSize()]; + data = new char[in_stream->StreamSize()]; - in\_stream->Read(data, in\_stream->StreamSize()); - if (in\_stream->LastError() != wxStream\_NOERROR) { + in_stream->Read(data, in_stream->StreamSize()); + if (in_stream->LastError() != wxStream_NOERROR) { // Do something. } - delete in\_stream; /* Close the DATA connection */ + delete in_stream; /* Close the DATA connection */ ftp.Close(); /* Close the COMMAND connection */ \end{verbatim}