You are here: Start » AVL.NET » AVL.Ftp_ReceiveImage Method
AVL.Ftp_ReceiveImage Method
Downloads an image from a remote server using FTP (File Transfer Protocol).
| Namespace: | AvlNet |
|---|---|
| Assembly: | AVL.NET.dll |
Syntax
public static void Ftp_ReceiveImage( string inHostName, string inFtpFilePath, string inUsername, string inPassword, bool inUsePassiveMode, bool inLoadAlphaChannel, out AvlNet.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 | string | User name needed to log in. Default value: atl::NIL, or null. | ||
| inPassword | string | Password associated with a user name. Default value: atl::NIL, or null. | ||
| inUsePassiveMode | bool | Protocol communication mode. May be necessary when using a firewall. | ||
| inLoadAlphaChannel | bool | Whether to load the alpha channel (if exists) as an additional image channel. | ||
 | outImage | AvlNet.Image | Image downloaded from the remote server. |
Errors
| Error type | Description |
|---|---|
| DomainError | Empty host name on input in Ftp_ReceiveImage |
| DomainError | Empty ftp file path on input in Ftp_ReceiveImage |
