Xceed Logo
Shop
Xceed FTP Library Documentation
XceedFtp control reference / Events / FileMatched event
In This Topic
    FileMatched event
    In This Topic

    Description

    This event is triggered for each file that matches the specified file mask of a call to either the SendMultipleFiles or the ReceiveMultipleFiles methods.

    Your handler for this event can set the bSkipFile parameter to True to prevent the file from being transferred, even though it matches the file mask. This allows you to create your own custom filters based on the information provided by this event’s other parameters.

    Parameters 

    Parameter Description
    sFilename  When sending a file, this parameter will contain the full path and filename of the file that was matched. When receiving a file, this parameter will contain only the name of the file that was matched.
     
    dtDate   The file date of the local or remote file that was matched.
    lFileSize   The file size of the local or remote file that was matched.
    eItemType   When sending files, this parameter is always fitFile. When receiving files, this parameter can be either fitFile or fitLink.
    bSkipFile   Set this parameter to True if you want to skip this file from being sent or received.
    sUserData  The value that was provided to the ParsingListLine event’s sUserData parameter. 0 if you did not write a handler for that event.

     

    Declaration (event)  
    void FileMatched(
       [in] BSTR sFilename, 
       [in] DATE dtDate, 
       [in] long lFileSize, 
       [in] EXFFolderItemType eItemType, 
       [in,out] VARIANT_BOOL* bSkipFile, 
       [in] BSTR sUserData 
    ); 
    Declaration (interface implementation)  
    HRESULT FileMatched(
       [in] BSTR sFilename, 
       [in] DATE dtDate, 
       [in] long lFileSize, 
       [in] EXFFolderItemType eItemType, 
       [in,out] VARIANT_BOOL* bSkipFile, 
       [in] BSTR sUserData 
    ); 

     

     

    © Xceed Software Inc. All Rights Reserved.

    Send comments on this topic.