FTP

<< Fare clic per visualizzazione il sommario >>

Percorso:  API di piattaforma > Altri servizi >

FTP

Descrizione

I metodi di questo servizio consentono il trasferimento file da e per FTP.

 

Proprietà

Proprietà utili alla connessione e al login di tipologia DataSet.

Download FTPSettings data structure.

 

Il parametro contiene i seguenti campi (tutti opzionali se non diversamente specificato):

Name

Description

Type

Optional

ServerName

The server address, either a hostname or a dotted string IP address.

String

 

ServerPort

The server port.

Int32

 

SslMode

The TLS/SSL security mode (*** ignored for SFtp ***):

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

1 = Implicit (implicitly secured TLS/SSL connection)

2 = Explicit (explicitly secured TLS/SSL connection)

Int32

 

UserName

The username; if null, “anonymous” is used.

String

 

Password

Password for the given username; if null, “guest” is used.

String

 

Passive

The file transfer type; default is true (passive); *** ignored for SFtp ***

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

Boolean

 

ProxyType

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); *** not usable for SFtp ***

6 = FtpUser (connection through FTP proxy using USER command); *** not usable for SFtp ***

7 = FtpOpen (connection through FTP proxy using OPEN command); *** not usable for SFtp ***

Int32

 

ProxyHost

The hostname of the proxy server.

String

 

ProxyPort

The port of the proxy server.

Int32

 

ProxyUserName

A username to submit to the proxy server for authentication.

String

 

ProxyPassword

A password to submit to the proxy server for authentication.

String

 

ProxyAuthenticationMethod

The type of the proxy server authentication method:

0 = Basic (Basic authentication)

1 = Ntlm (NTLM authentication)

2 = Digest (Digest authentication)

Int32

 

ProxyBypassProxyOnLocal

True to bypass the proxy server for local addresses, otherwise false; the default value is false.

Boolean

 

SFtp

True to use SFtp instead of Ftp; default is false (Ftp).

Boolean

 

 

Metodi

I metodi del connettore FTP sono elencati di seguito:

Ftp-Version

Restituisce la versione del connettore.

CreateDirectory

Crea una directory sul server.

CreateDirectoryOnServer

Crea una directory sul server; il server FTP è specificato in modo esplicito.

CreateDirectoryOnServerSFtp

Crea una directory su un server SFtp; il server SFtp è specificato in modo esplicito.

RemoveDirectory

Cancella una directory vuota allocata come indica il percorso specificato.

RemoveDirectoryOnServer

Cancella una directory vuota allocata come indica il percorso specificato.

RemoveDirectoryOnServerSFtp

Cancella una directory vuota allocata come indica il percorso specificato. Il server SFtp deve essere esplicitamente specificato.

DirectoryExists

Verifica se la directory specificata esiste sul server. Non tutti i server Ftp supportano tale metodo.

DirectoryExistsOnServer

Verifica se la directory specificata esiste sul server Ftp. Non tutti i server Ftp supportano tale metodo.

DirectoryExistsOnServerSFtp

Verifica se la directory specificata esiste sul server SFtp.

FileExists

Verifica se il file specificato esiste sul server. Non tutti i server Ftp supportano tale metodo.

FileExistsOnServer

Verifica se il file specificato esiste sul server Ftp. Non tutti i server Ftp supportano tale metodo.

UploadFile

Effettua il caricamento del contenuto del file locale nel file sul server Ftp. Se esiste già il file sul server Ftp, il file può essere sovrascritto oppure il caricamento può essere rifatto.

UploadFileToServer

Effettua il caricamento del contenuto di una file locale nel file sul server Ftp specificato. Se esiste già il file sul server Ftp, il file può essere sovrascritto oppure il caricamento può essere rifatto.

UploadFileStream

Effettua il caricamento del contenuto di una reference dell’allegato di un’istanza di processo sul server Ftp. Se esiste già il file sul server Ftp, il file può essere sovrascritto oppure il caricamento può essere rifatto.

UploadFileStreamToServer

Effettua il caricamento del contenuto di una reference dell’allegato di un’istanza di processo sul server Ftp specificato. Se esiste già il file sul server Ftp, il file può essere sovrascritto oppure il caricamento può essere rifatto.

UploadFileStreamToServerSFtp

Effettua il caricamento del contenuto di una reference dell’allegato di un’istanza di processo sul server SFtp specificato. Se esiste già il file sul server SFtp, il file può essere sovrascritto oppure il caricamento può essere rifatto.

Upload

Effettua il caricamento del file locale specificato o della directory indicata, in una directory del server Ftp. Sono consentiti caratteri jolly.

DownloadFile

Effettua il download del file allocato sul server in un file locale. Se il file locale esiste già, il file può essere sovrascritto oppure oppure il download può essere rifatto.

DownloadFileFromServer

Effettua il download del file allocato sul server in una reference dell’allegato di un’istanza di processo; il server Ftp deve essere esplicitamente specificato.

DownloadFileStream

Effettua il download del file allocato sul server in una reference dell’allegato di un’istanza di processo.

DownloadFileStreamFromServer

Effettua il download del file allocato sul server in una reference dell’allegato di un’istanza di processo; il server Ftp deve essere esplicitamente specificato.

DownloadFileStreamsFromServer

Effettua il download di più file allocati sul server e restituisce un dato strutturato contenente i collegamenti ai file scaricati; il server Ftp deve essere esplicitamente specificato.

Download

Effettua il download del file specificato o della directory indicata, in una directory del server Ftp. Sono consentiti caratteri jolly.

DeleteFile

Elimina il file dal server.

Delete

Elimina il file o la directory specificati sul server Ftp. Sono consentiti caratteri jolly.

DeleteOnServer

Elimina il file o la directory specificati sul server Ftp. Sono consentiti caratteri jolly.

DeleteFileOnServer

Elimina il file specificato dal server FTP.

DeleteFileOnServerSFtp

Elimina il file specificato dal server SFTP.

Rename

Rinomina un file sul server Ftp.

RenameOnServer

Rinomina un file sul server Ftp specificato.

CopyToServer

Copia un file presente su un server Ftp su un altro server utilizzando il trasferimento diretto server-to-server, nota come FXP. Non è supportata per SFtp.

CopyFromServer

Copia un file presente su un server Ftp su un altro server utilizzando il trasferimento diretto server-to-server, nota come FXP. Non è supportata per SFtp.

GetInfo

Restituisce un dato strutturato che contiene informazioni riguardanti il file remoto o la directory remota indicati.

GetInfoOnServer

Restituisce un dato strutturato che contiene informazioni riguardanti il file remoto o la directory remota indicati.

WriteTextFile

Scrive un file di testo sul server Ftp. Se il file esiste già, esso può essere sovrascritto oppure si può aggiungere il nuovo testo al contenuto del file.

WriteTextFileOnServer

Scrive un file di testo sul server Ftp specificato in input. Se il file esiste già, esso può essere sovrascritto oppure si può aggiungere il nuovo testo al contenuto del file.

GetList

Restituisce la lista di file e directory presenti nella directory del server specificata.

GetListOnServer

Restituisce la lista di file e directory presenti nella directory del server specificata.

SearchFilesWithWildcards

Restituisce una lista di file presenti in una specifica directory del server, che rispettano i parametri di ricerca indicati.

SearchFilesWithWildcardsOnServer

Restituisce una lista di file presenti in una specifica directory del server, che rispettano i parametri di ricerca indicati.

SearchFilesWithRegEx

Restituisce una lista di file presenti in una specifica directory del server, che rispettano la Regular expression indicata.

SearchFilesWithRegExOnServer

Restituisce una lista di file presenti in una specifica directory del server, che rispettano la Regular expression indicata.