Back to Adaptive Vision Library websiteYou are here:
Start »
Function Reference »
FTP »
Ftp_ReceiveImage
Downloads an image from a remote server using FTP (File Transfer Protocol).
Syntax
C++
C#
void avl::Ftp_ReceiveImage
(
const atl::String& inHostName,
const atl::String& inFtpFilePath,
atl::Optional<const atl::String&> inUsername,
atl::Optional<const atl::String&> inPassword,
bool inUsePassiveMode,
bool inLoadAlphaChannel,
avl::Image& outImage
)
void Ftp_ReceiveImage
(
System.String inHostName,
System.String inFtpFilePath,
System.String inUsername,
System.String inPassword,
bool inUsePassiveMode,
bool inLoadAlphaChannel,
out Image outImage
)
Parameters
|
Name |
Type |
Default |
Description |
|
inHostName |
const String& |
\"ftp://\" |
URL address of the remote server. |
|
inFtpFilePath |
const String& |
|
Location of the file on a remote server. |
|
inUsername |
Optional<const String&> |
NIL |
User name needed to log in |
|
inPassword |
Optional<const String&> |
NIL |
Password associated with a user name. |
|
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 |
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 |