Download files from a remote server
Namespace:
NetQuarry
Assembly:
EAP.Core (in EAP.Core.dll) Version: 2.0.0.0 (4.6.8.0)
Syntax bool DownloadFile(
string remotePath,
string remoteFile,
string localPath,
string localFile,
FTPFileTransferAttributes transferAttrs,
FTPCreateDisposition disposition,
FTPRemoteAccessMode access
)
Function DownloadFile (
remotePath As String,
remoteFile As String,
localPath As String,
localFile As String,
transferAttrs As FTPFileTransferAttributes,
disposition As FTPCreateDisposition,
access As FTPRemoteAccessMode
) As Boolean
Parameters
- remotePath
- Type: SystemString
The path to files to download on remote server - remoteFile
- Type: SystemString
A file name pattern to select files to download. Accepts standard wildcard naming convention (e.g. *.xml to download all xml files from the specified remote folder) - localPath
- Type: SystemString
Path to store downloaded files on local machine - localFile
- Type: SystemString
Full path and name of transferred file on local machine - transferAttrs
- Type: NetQuarryFTPFileTransferAttributes
Specify Behavior of file transfer session - disposition
- Type: NetQuarryFTPCreateDisposition
Set the file creation properties for the transfer - access
- Type: NetQuarryFTPRemoteAccessMode
Set the file access properties for the transfer
Return Value
Type:
BooleanTrue upon successful transfer, else false.
See Also