X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/fa482912e420a40e9f2e55a0f5407562826dd15e..80d2803f703d1b238f42725504f08266ef02defe:/docs/latex/wx/ftp.tex diff --git a/docs/latex/wx/ftp.tex b/docs/latex/wx/ftp.tex index 07d711056e..e3c5050379 100644 --- a/docs/latex/wx/ftp.tex +++ b/docs/latex/wx/ftp.tex @@ -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. % ---------------------------------------------------------------------------- @@ -180,7 +181,7 @@ 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 when you