Back to product page

LoopErrorEvent event


Fires after wodSFTP.NET performs operation on item and error occurs.

Syntax

  • C#
  • VB.NET
delegate void LoopDelegate(object Sender, LoopArgs Args);
The LoopErrorEvent(Args.Error,Args.ItemType,Args.LocalFile,Args.RemoteFile,Args.Skip) syntax has these parts:
Args.ErrorException. Exception information about the error, if error occurred.
Args.ItemTypeDirItemTypes enumeration value. Type of the item - file, folder, symbolic link.
Args.LocalFileString. Full path to file/folder on local disk.
Args.RemoteFileString. Full path to file/folder on remote server.
Args.SkipBoolean. When set to True then intended operation is not performed on the item.

Delegate Sub LoopDelegate(ByVal Sender As Object, ByVal Args As WeOnlyDo.Client.SFTP.LoopArgs)
The LoopErrorEvent(Args.Error,Args.ItemType,Args.LocalFile,Args.RemoteFile,Args.Skip) syntax has these parts:
Args.ErrorException. Exception information about the error, if error occurred.
Args.ItemTypeDirItemTypes enumeration value. Type of the item - file, folder, symbolic link.
Args.LocalFileString. Full path to file/folder on local disk.
Args.RemoteFileString. Full path to file/folder on remote server.
Args.SkipBoolean. When set to True then intended operation is not performed on the item.

Remarks

The LoopError event is fired as result of error that occurred during execution of GetFiles, DeleteFiles, PutFiles and LoopFiles methods. Since those methods are working with many files/folders in a sequence, error may occur while, for example, creating directory, accessing files (like permission problems) etc.. When an error happens, this event is fired and Args.Error is provided with information about the error. You can now evaluate the error to determine why your method failed.

You are allowed to set Args.Error = null (Nothing in VB) inside this event, which would cause method to continue performing its work on rest of items, completely ignoring the error. If you don't set Args.Error to null, then method will return immediately with the error as soon as you leave this event.

Platforms

Windows