You are here: Start » FIL.NET » Function Reference » System » FTP » FIL.Ftp_ReceiveImage
FIL.Ftp_ReceiveImage
Downloads an image from a remote server using FTP (File Transfer Protocol).
| Namespace: | FilNet |
|---|---|
| Assembly: | FIL.NET.dll |
Syntax
C++
C#
public static void Ftp_ReceiveImage ( string inHostName, string inFtpFilePath, NullableRef<string> inUsername, NullableRef<string> inPassword, bool inUsePassiveMode, int? inTimeout, bool inAllowUntrusted, NullableRef<string> inCaCertFile, bool inLoadAlphaChannel, FilNet.Image outImage )
Parameters
| Name | Type | Range | Default | Description | |
|---|---|---|---|---|---|
 | 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. | ||
| inTimeout | int? | <0, INF> | Request timeout in seconds. Default value: ftl::NIL. | |
| inAllowUntrusted | bool | False | Whether or not to allow untrusted SSL certificates. Default value: False. | |
| inCaCertFile | FilNet.NullableRef<string> | File holding one or more certificates to verify the peer with. Default value: ftl::NIL. | ||
| inLoadAlphaChannel | bool | Whether to load the alpha channel (if exists) as an additional image channel. | ||
 | outImage | FilNet.Image | Image downloaded from the remote server. |
Errors
List of possible exceptions:
| Error type | Description |
|---|---|
| DomainError | Empty ftp file path on input in Ftp_ReceiveImage |
| DomainError | Empty host name on input in Ftp_ReceiveImage |
