LoopError method
Called after wodSFTP performs operation on item and error occurs.
Type
NoneSyntax
object.LoopError Owner, LocalFile, RemoteFile, ItemType, ErrorCode, ErrorText
The LoopError(object,Owner,LocalFile,RemoteFile,ItemType,ErrorCode,ErrorText) syntax has these parts:
| object | An expression evaluating to an object of type IwodSFTPNotify. |
| Owner | A wodSFTPCom object. |
| LocalFile | A String value. Full path to file/folder on local disk. |
| RemoteFile | A String value. Full path to file/folder on remote server. |
| ItemType | A DirItemTypes enumeration. Type of the item - file, folder, symlink. |
| ErrorCode | A Long value. Code of the error, if error occurred. |
| ErrorText | A String value. Text description of the error, if available. |
Remarks
This method is only called if you implemented the IwodSFTPNotify interface in your application and the wodSFTP.Notification property has received a reference to an instance of your implementation.
The LoopError notification method is called as a 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 notification method is called and error is provided in
ErrorCode and
ErrorText arguments. You can now evaluate the error to determine why your method failed.
You are allowed to set
ErrorCode = 0 inside this notification method, which would cause method to continue performing its work on rest of items, completely ignoring the error. If you don't set
ErrorCode to 0, then method will return immediately with the error as soon as you leave this notification method.
Platforms
Windows
Back to product page