DownloadFileStreamFromServer

<< Fare clic per visualizzazione il sommario >>

Percorso:  API di piattaforma > Altri servizi > FTP >

DownloadFileStreamFromServer

Service

FTP

 

Method

DownloadFileStreamFromServer

 

Description

Downloads the remote file to a process attachment reference ; the FTP server is explicitly specified.

 

Input

Name

Description

Type

Optional

server

Connection and login information for the server.

 

Download FTPSettings data structure.

Dataset

 

remotePath

The path of the remote file.

String

 

Output

Name

Description

Type

Optional

returnValue

A reference to the process attachment that containing the downloaded file.

Reference

 

 

Remarks

The server parameter contains the following fields:

“ServerName” (String) -> the server address, either a hostname or a dotted string IP address

“ServerPort” (Int32) -> the server port

“SslMode” (Int32) -> the TLS/SSL security mode:

0 = None (unsecured connection, no TLS/SSL)

1 = Implicit (implicitly secured TLS/SSL connection)

2 = Explicit (explicitly secured TLS/SSL connection)

“UserName” (String) -> the username; if null, “anonymous” is used

“Password” (String) -> password for the given username; if null, “guest” is used

“Passive” (Boolean) -> the file transfer type; default is true (passive)

Passive mode: data transfer connections are made by the client, which connects to the server

Active mode: data transfer connections are made by the server, which connects to the client

Firewalls and NATs often make it impossible to use active transfers

When using HttpConnect proxy, this property is ignored and all transfers are passive

“ProxyType” (Int32) -> the proxy type:

0 = None (direct connection, default when no proxy is specified)

1 = Socks4 (connection through Socks4 proxy)

2 = Socks4a (connection through Socks4A proxy (capable of resolving domain names))

3 = Socks5 (connection through Socks5 proxy)

4 = HttpConnect (connection through HTTP proxy using CONNECT method)

5 = FtpSite (connection through FTP proxy using SITE command)

6 = FtpUser (connection through FTP proxy using USER command)

7 = FtpOpen (connection through FTP proxy using OPEN command)

“ProxyHost” (String) -> the hostname of the proxy server

“ProxyPort” (Int32) -> the port of the proxy server

“ProxyUserName” (String) -> a username to submit to the proxy server for authentication

“ProxyPassword” (String) -> a password to submit to the proxy server for authentication

“ProxyAuthenticationMethod” (Int32) -> the type of the proxy server authentication method:

0 = Basic (Basic authentication)

1 = Ntlm (NTLM authentication)

2 = Digest (Digest authentication)

“ProxyBypassProxyOnLocal” (Boolean) -> true to bypass the proxy server for local addresses, otherwise false; the default value is false

“SFtp” (Boolean) -> true to use SFtp instead of Ftp; default is false (Ftp)