Xceed Logo
Shop
Xceed FTP Library Documentation
XceedQuickFtp control reference / ReceiveMultipleFiles method (XceedQuickFTP)
In This Topic
    ReceiveMultipleFiles method (XceedQuickFTP)
    In This Topic

    Description

    Connects to an FTP server, receives multiple files or an entire directory structure, then disconnects from the FTP server.

    Parameters 

    Parameter Description
    sServerAddress  The IP address or host name of the FTP server to connect to.
    lServerPort  The IP port that the FTP server is listening on (usually 21).
    sUserName  The username to log in (usually "anonymous").
    sPassword  The password (for anonymous users, usually "guest").
    sRemoteFileMask  The file mask (path optional) of the remote files to receive. All the remote files that match the path and file mask specified by the sRemoteFileMask parameter will be received. See Wildcards .
    bProcessSubfolders  Pass True to recursively scan remote subfolders to find files that match the sRemoteFileMask parameter. Pass False to receive only files directly located in the specified remote path without scanning subfolders.
    sLocalFolder  The files that end up being received are placed in the local folder specified by this parameter.
    bAsciiTransfer  Pass True to receive the files in ASCII mode, or pass False to receive the files in binary mode.

    Examples

    Visual Basic Copy Code
    XceedQuickFtp1.ReceiveMultipleFiles("ftp.myserver.com",21,"jacob","secret", _
                                        "/texts/*.zip", False, "c:\received\", False)
    Delphi Copy Code
    XceedQuickFtp1.ReceiveMultipleFiles('10.18.102.93',21,'anonymous','guest','*',
                                        True, '\\Server\mirror\', False);

    ATL example

    Declaration  
    HRESULT ReceiveMultipleFiles
    (
       [in] BSTR sServerAddress, 
       [in] long lServerPort, 
       [in] BSTR sUserName, 
       [in] BSTR sPassword, 
       [in] BSTR sRemoteFileMask, 
       [in] VARIANT_BOOL bProcessSubfolders, 
       [in] BSTR sLocalFolder, 
       [in] VARIANT_BOOL bAsciiTransfer 
    ); 

    Applicable properties

    None (The XceedQuickFtp object doesn't have any properties)

    Events triggered

    None (The XceedQuickFtp object doesn't have any events)

     

     

    © Xceed Software Inc. All Rights Reserved.

    Send comments on this topic.