You are here: Start » AVL.NET » AVL.Ftp_ReceiveImage(string, string, string, string, bool, bool, AvlNet.Image)

AVL.Ftp_ReceiveImage(string, string, string, string, bool, bool, AvlNet.Image)

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

inHostName
Type: System.String
URL address of the remote server.
inFtpFilePath
Type: System.String
Location of the file on a remote server.
inUsername
Type: System.String
User name needed to log in, or null.
inPassword
Type: System.String
Password associated with a user name, or null.
inUsePassiveMode
Type: System.Boolean
Protocol communication mode. May be necessary when using a firewall.
inLoadAlphaChannel
Type: System.Boolean
Whether to load the alpha channel (if exists) as an additional image channel
outImage
Type: 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

See also