:GetMultipleFiles()
Class
Syntax
:GetMultipleFiles([cRemoteDir], [cLocalDir], [cFileMask], [hSession] ) -> lSuccess
Parameters
|
|
cRemoteDir |
Optional. String which specifies the remote directory where the files will be copied from. If not passed or string is empty, specifies that the files should be copied from the current working directory on the server. |
|
|
cLocalDir |
Optional. String which specifies the local directory where the files will be copied to. If not passed or string is empty, specifies that files should be copied to the current working directory. |
|
|
cMask |
Optional. String which specifies the files that are to be copied from the remote server to the local system. The file mask should follow the native conventions used for wildcard file matches on the remote host. Default is all files. |
|
|
hSession |
Optional: If hSession is not passed, the value in :Session will be used |
Return
Logical indicating Success.
Returns .T. if the operation succeeds, otherwise returns .F.
To get further error information see :nErr and :cErr
To see the remote server's response, see :GetResultCode() and :GetResultString().
Description
The :GetMultipleFiles() method copies one or more files from the remote system to the local host, using the specified wildcard.
The :GetMultipleFiles() method is used to transfer files from the remote server to the local host which match a specified wildcard file mask. This function requires that the client be able to automatically list and parse directory listings from the server, otherwise an error will be returned. All files will be transferred using the current file type as specified by the :SetFileType() method.
See Also
:ChangeDirectory(), :GetFile(), :PutFile(), :PutMultipleFiles(), :SetFileMask()