You are here: Start » FIL.NET » FIL.Ftp_ReceiveFile
FIL.Ftp_ReceiveFile
Downloads a file from a remote server using FTP (File Transfer Protocol).
| Namespace: | FilNet |
|---|---|
| Assembly: | FIL.NET.dll |
Syntax
C++
C#
public static void Ftp_ReceiveFile ( string inFilePath, string inHostName, string inFtpFilePath, NullableRef<string> inUsername, NullableRef<string> inPassword, bool inUsePassiveMode )
Parameters
| Name | Type | Range | Default | Description | |
|---|---|---|---|---|---|
 | inFilePath | string | Location of the file on a remote server. | ||
| inHostName | string | \"ftp://\" | URL address of the remote server. Default value: "ftp://". | |
| inFtpFilePath | string | Location of the file on a remote server. | ||
| inUsername | FilNet.NullableRef<string> | User name needed to log in. Default value: ftl::NIL. | ||
| inPassword | FilNet.NullableRef<string> | Password associated with a user name. Default value: ftl::NIL. | ||
| inUsePassiveMode | bool | Protocol communication mode. May be necessary when using a firewall. |
Errors
List of possible exceptions:
| Error type | Description |
|---|---|
| DomainError | Empty ftp file path on input in Ftp_ReceiveFile |
| DomainError | Empty host name on input in Ftp_ReceiveFile |
| DomainError | Empty path on input in Ftp_ReceiveFile |
