 | SFTPGetFiles Method (FTPHeader, 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(
FTPHeader ftpHeader,
string serverPath,
string localDestPath,
FTPFilterType filterType = FTPFilterType.None,
string filterText = null,
bool forceOverwrite = false,
bool keepOrigDateTime = false,
bool deleteAfterRetrieve = false
)
Public Shared Function GetFiles (
ftpHeader As FTPHeader,
serverPath As String,
localDestPath As String,
Optional filterType As FTPFilterType = FTPFilterType.None,
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(
FTPHeader^ ftpHeader,
String^ serverPath,
String^ localDestPath,
FTPFilterType filterType = FTPFilterType::None,
String^ filterText = nullptr,
bool forceOverwrite = false,
bool keepOrigDateTime = false,
bool deleteAfterRetrieve = false
)
static member GetFiles :
ftpHeader : FTPHeader *
serverPath : string *
localDestPath : string *
?filterType : FTPFilterType *
?filterText : string *
?forceOverwrite : bool *
?keepOrigDateTime : bool *
?deleteAfterRetrieve : bool
(* Defaults:
let _filterType = defaultArg filterType FTPFilterType.None
let _filterText = defaultArg filterText null
let _forceOverwrite = defaultArg forceOverwrite false
let _keepOrigDateTime = defaultArg keepOrigDateTime false
let _deleteAfterRetrieve = defaultArg deleteAfterRetrieve false
*)
-> FWRetVal<string>
Parameters
- ftpHeader
- Type: Koden.Utils.FTPClientFTPHeader
The FTP header. - serverPath
- Type: SystemString
The server path. - localDestPath
- Type: SystemString
The local dest path. - filterType (Optional)
- 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 [keep original date time]. - deleteAfterRetrieve (Optional)
- Type: SystemBoolean
if set to true [delete after retrieve].
Return Value
Type:
FWRetValString
FWRetVal sring the "Record" contains number of files copied
See Also