 | SFTPGetFiles Method (String, String, String, String, String, FTPFilterType, String, Boolean, Boolean, Boolean) |
Gets all the files in a remote directory with an optional filter on the extension.
Namespace:
Koden.Utils.FTPClient
Assembly:
Koden.Utils.FTPClient (in Koden.Utils.FTPClient.dll) Version: 1.1.6453.26060
Syntaxpublic static FWRetVal<string> GetFiles(
string strHost,
string strUserName,
string strPassword,
string serverPath,
string localDestPath,
FTPFilterType filterType,
string filterText = null,
bool forceOverwrite = false,
bool keepOrigDateTime = false,
bool deleteAfterRetrieve = false
)
Public Shared Function GetFiles (
strHost As String,
strUserName As String,
strPassword As String,
serverPath As String,
localDestPath As String,
filterType As FTPFilterType,
Optional filterText As String = Nothing,
Optional forceOverwrite As Boolean = false,
Optional keepOrigDateTime As Boolean = false,
Optional deleteAfterRetrieve As Boolean = false
) As FWRetVal(Of String)
public:
static FWRetVal<String^>^ GetFiles(
String^ strHost,
String^ strUserName,
String^ strPassword,
String^ serverPath,
String^ localDestPath,
FTPFilterType filterType,
String^ filterText = nullptr,
bool forceOverwrite = false,
bool keepOrigDateTime = false,
bool deleteAfterRetrieve = false
)
static member GetFiles :
strHost : string *
strUserName : string *
strPassword : string *
serverPath : string *
localDestPath : string *
filterType : FTPFilterType *
?filterText : string *
?forceOverwrite : bool *
?keepOrigDateTime : bool *
?deleteAfterRetrieve : bool
(* Defaults:
let _filterText = defaultArg filterText null
let _forceOverwrite = defaultArg forceOverwrite false
let _keepOrigDateTime = defaultArg keepOrigDateTime false
let _deleteAfterRetrieve = defaultArg deleteAfterRetrieve false
*)
-> FWRetVal<string>
Parameters
- strHost
- Type: SystemString
The host. - strUserName
- Type: SystemString
UserName to use - strPassword
- Type: SystemString
Password to use - serverPath
- Type: SystemString
The Server Path to get files from - localDestPath
- Type: SystemString
The local dest path to save files to. - filterType
- Type: Koden.Utils.FTPClientFTPFilterType
Type of the filter (None, StartsWith, etc). - filterText (Optional)
- Type: SystemString
The filter. - (do not use * or %) - forceOverwrite (Optional)
- Type: SystemBoolean
if set to true [force overwrite]. - keepOrigDateTime (Optional)
- Type: SystemBoolean
if set to true touches files with FTP Date/Time and not local Creation Date/Time. - deleteAfterRetrieve (Optional)
- Type: SystemBoolean
if set to true [delete after retrieve].
Return Value
Type:
FWRetValStringFWRetVal int the "Record" contains number of files copied
See Also