GetListOnServerSFtp

<< Fare clic per visualizzazione il sommario >>

Percorso:  API di piattaforma > Altri servizi > FTP >

GetListOnServerSFtp

Service

FTP

 

Method

GetListOnServerSFtp

 

Description

Returns parsed list of files and directories in the specified server directory; the SFtp server is explicitly specified.

 

 

Input

Name

Description

Type

Optional

server

Connection and login information for the server.

 

Download FTPSettings data structure.

Dataset

 

remoteDirectoryPath

The pathname of the remote directory.

String

 

Output

Name

Description

Type

Optional

returnValue

A dataset containing a file information list.

 

Download Data Structure.

List of Dataset

 

 

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) -> ignored);

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

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

"Passive" (Boolean) -> ignored;

"SFtp" (Boolean) -> must be true.

 

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

 

The returned list contains a dataset for each item, containing the following fields:

 

“CreationTime” (DateTime) -> the creation time of the item (if not null)

“IsDirectory” (Boolean) -> true if the item is a directory, otherwise false

“IsFile” (Boolean) -> true if the item is a file, otherwise false

“IsLink” (Boolean) -> true if the item is a link, otherwise false

“LastAccessTime” (DateTime) -> the last access time of the item (if not null)

“LastWriteTime” (DateTime) -> the last modification time of the item (if not null)

“Length” (Int64) -> the file length

“Name” (String) -> the name of the file or directory

“Path” (String) -> the relative path of the file or directory