You are here: Start » AVL.NET » Function Reference » System » FTP » AVL.Ftp_ReceiveImage

AVL.Ftp_ReceiveImage

Downloads an image from a remote server using FTP (File Transfer Protocol).

Namespace:AvlNet
Assembly:AVL.NET.dll

Syntax

C++
C#
 
public static void Ftp_ReceiveImage
(
	string inHostName,
	string inFtpFilePath,
	bool inUsePassiveMode,
	bool inLoadAlphaChannel,
	AvlNet.Image outImage
)

Parameters

Name Type Range Default Description
inHostNamestring\"ftp://\"URL address of the remote server. Default value: "ftp://".
inFtpFilePathstringLocation of the file on a remote server.
inUsePassiveModeboolProtocol communication mode. May be necessary when using a firewall.
inLoadAlphaChannelboolWhether to load the alpha channel (if exists) as an additional image channel.
outImageAvlNet.ImageImage 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

Function Overrides

See also