 | FTPGetFiles Method (FTPHeader, String, String, FTPFilterType, String, 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 GetFiles(
FTPHeader ftpHeader,
string serverPath,
string localDestPath,
FTPFilterType filterType,
string filter = null,
bool keepOrigDateTime = false,
bool deleteAfterRetrieve = false
)
Public Shared Function GetFiles (
ftpHeader As FTPHeader,
serverPath As String,
localDestPath As String,
filterType As FTPFilterType,
Optional filter As String = Nothing,
Optional keepOrigDateTime As Boolean = false,
Optional deleteAfterRetrieve As Boolean = false
) As FWRetVal
public:
static FWRetVal^ GetFiles(
FTPHeader^ ftpHeader,
String^ serverPath,
String^ localDestPath,
FTPFilterType filterType,
String^ filter = nullptr,
bool keepOrigDateTime = false,
bool deleteAfterRetrieve = false
)
static member GetFiles :
ftpHeader : FTPHeader *
serverPath : string *
localDestPath : string *
filterType : FTPFilterType *
?filter : string *
?keepOrigDateTime : bool *
?deleteAfterRetrieve : bool
(* Defaults:
let _filter = defaultArg filter null
let _keepOrigDateTime = defaultArg keepOrigDateTime false
let _deleteAfterRetrieve = defaultArg deleteAfterRetrieve false
*)
-> FWRetVal
Parameters
- ftpHeader
- Type: Koden.Utils.FTPClientFTPHeader
The FTP header. - 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). - filter (Optional)
- Type: SystemString
The filter. - (do not use * or %) - 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:
FWRetVal[Missing <returns> documentation for "M:Koden.Utils.FTPClient.FTP.GetFiles(Koden.Utils.FTPClient.FTPHeader,System.String,System.String,Koden.Utils.FTPClient.FTPFilterType,System.String,System.Boolean,System.Boolean)"]
See Also