LoopItemEvent Event

Fires before wodFtpDLX.NET performs operation on file from the GetFiles/PutFiles/DeleteFiles/LoopFiles sequence.

[Visual Basic]
Public Event LoopItemEvent() As FtpDLX.LoopDelegate

[C#]
public event FtpDLX.LoopDelegate LoopItemEvent();

[JScript]
In JScript, you can handle the events defined by another class, but you cannot define your own.

Remarks

This event fires as result of GetFiles, DeleteFiles, PutFiles and LoopFiles methods. It provides information about each item in the sequence (meaning file or folder) before actual operation on that item is executed - allowing you to optionally Skip the operation for this particular item.

Since both Args.LocalFile and Args.RemoteFile arguments can be changed, you can also cause operation to be performed on completely different files than it would be in original operation.

For example, you can use LoopItem event like this:

Private Sub Ftp1_LoopItemEvent(ByVal Sender As Object, ByVal Args As WeOnlyDo.Client.FtpLoopArgs) Handles Ftp1.LoopItemEvent
If Args.ItemType = WeOnlyDo.Client.DirItemTypes.Directory Then
Args.Skip = False
Else
If Args.RemoteFile.EndsWith(".txt") Then
Args.Skip = False
Else
Args.Skip = True
End If
End If
End Sub

which means that only files ending with ".txt" are copied - others are skipped (but directories are created, just in case).

You can also use it like this: we will copy all ".txt" files to the same directory, no matter where they originate from:

Private Sub Ftp1_LoopItemEvent(ByVal Sender As Object, ByVal Args As WeOnlyDo.Client.FtpLoopArgs) Handles Ftp1.LoopItemEvent
If Args.RemoteFile.EndsWith(".txt") Then
Args.LocalFile = "c:\mytxtfiles\file" & Counter & ".txt"
Counter = Counter + 1
Args.Skip = False
Else
Args.Skip = True
End If
End Sub

above sample will not create directory structure at all - but still would copy all .txt files to differently named files on local disk.

Requirements

Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family

See Also

FtpDLX Class  | FtpDLX Members

© WeOnlyDo Software. All Rights Reserved.