Integration Server 10.3 | Built-In Services Reference Guide | Client Folder | Summary of Elements in this Folder | pub.client.ftp:mget
 
pub.client.ftp:mget
WmPublic. Transfers multiple files from the remote FTP server. (This service corresponds to the standard FTP command mget.)
Input Parameters
sessionkey
String Unique key for the current FTP session. The sessionkey is returned by the pub.client.ftp:login service.
transfermode
String FTP file transfer mode (ascii or binary). The default is ascii.
localdir
String Directory in the local file system where the retrieved files are to be saved (for example, c:\temp\ftpfiles).
filenamepattern
String Pattern that specifies the names of the files to be retrieved (for example, *.txt).
encoding
String Optional. Character set in which the files are encoded. This variable is required to convert the files to bytes correctly. Specify an IANA-registered character set (for example, ISO-8859-1).
If you do not specify encoding, the encoding assigned to the FTP session is used. If the encoding was not set for the FTP session, the default JVM encoding is used.
Output Parameters
filenames
String List List of files retrieved from the remote FTP server.
returncode
String Standard FTP protocol return code.
returnmsg
String Standard FTP protocol return message.
logmsg
String FTP log messages for the entire user session.