X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/70be2567de053a3284a28e0dc8f0c1d91d9a8fb8..4e28924cdb58dfbba0ec6cd5d52ef1346d0cb569:/docs/latex/wx/ftp.tex diff --git a/docs/latex/wx/ftp.tex b/docs/latex/wx/ftp.tex index e5e591b1e0..e3c5050379 100644 --- a/docs/latex/wx/ftp.tex +++ b/docs/latex/wx/ftp.tex @@ -27,7 +27,7 @@ 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. % ---------------------------------------------------------------------------- @@ -121,11 +121,11 @@ 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. +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: @@ -146,7 +146,8 @@ 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. % ---------------------------------------------------------------------------- @@ -172,21 +173,21 @@ 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)}