Differences
This shows you the differences between the selected revisions of the page.
| library_example_recursive_download_custom_error_handling 2017-12-21 | library_example_recursive_download_custom_error_handling 2022-06-16 (current) | ||
| Line 1: | Line 1: | ||
| ====== Recursively download directory tree with custom error handling ====== | ====== Recursively download directory tree with custom error handling ====== | ||
| - | The simplest way to download a directory tree is by using ''[[library_session_getfiles|Session.GetFiles]]'', providing path to a root of the tree as a source. This way a batch operation however stops on any error. If you need to use a custom error handling, for example to ignore any error and just continue, you need to implement walking the tree explicitly. | + | The simplest way to download a directory tree is by using ''[[library_session_getfiles|Session.GetFiles]]'', providing path to a root of the tree as a source. This way a batch operation however stops on any error by default. |
| + | |||
| + | The following two approaches show how to override the default behaviour. | ||
| + | |||
| + | Particularly the first approach with ''[[library_session_queryreceived|Session.QueryReceived]]'' event is relevant for other batch operations as well, including ''[[library_session_putfiles|Session.PutFiles]]'' and ''[[library_session_synchronizedirectories|Session.SynchronizeDirectories]]''. | ||
| + | |||
| + | ===== [[queryreceived]] Handling Session.QueryReceived event ===== | ||
| + | |||
| + | You can choose how an error is processed by handling ''[[library_session_queryreceived|Session.QueryReceived]]'' event. | ||
| + | |||
| + | This example shows a basic implementation that outputs any errors encountered and continues. | ||
| + | |||
| + | ==== C# Example ==== | ||
| + | |||
| + | <code csharp> | ||
| + | session.QueryReceived += (sender, e) => | ||
| + | { | ||
| + | Console.WriteLine("Error: {0}", e); | ||
| + | e.Continue(); | ||
| + | }; | ||
| + | |||
| + | session.GetFiles("/home/user/*", @"d:\download\").Check(); | ||
| + | </code> | ||
| + | |||
| + | ==== VB.NET Example ==== | ||
| + | |||
| + | <code vbnet> | ||
| + | AddHandler session.QueryReceived, | ||
| + | Sub(sender As Object, e As QueryReceivedEventArgs) | ||
| + | Console.WriteLine("Error: {0}", e.Message) | ||
| + | e.Continue() | ||
| + | End Sub | ||
| + | |||
| + | session.GetFiles("/home/user/*", "d:\download\").Check() | ||
| + | </code> | ||
| + | |||
| + | ==== [[event_powershell]] PowerShell Example ==== | ||
| + | |||
| + | <code powershell> | ||
| + | $session.add_QueryReceived( { | ||
| + | Write-Host "Error: $($_.Message)" | ||
| + | $_.Continue() | ||
| + | } ) | ||
| + | |||
| + | $session.GetFiles("/home/user/*", "d:\download\").Check() | ||
| + | </code> | ||
| + | |||
| + | ==== Upload ==== | ||
| + | |||
| + | The same mechanism can be used for uploads with ''[[library_session_putfiles|Session.PutFiles]]'' or synchronization with ''[[library_session_synchronizedirectories|Session.SynchronizeDirectories]]''. | ||
| + | |||
| + | |||
| + | ===== [[tree_download]] Explicit Implementation of a File Tree Download ===== | ||
| + | |||
| + | In case you need even more control over a download process, you can implement walking of a directory tree explicitly and handle each file individually, as you need. | ||
| This example shows a basic implementation that outputs any errors encountered and continues. | This example shows a basic implementation that outputs any errors encountered and continues. | ||
| - | ===== C# Example ===== | + | ==== C# Example ==== |
| <code csharp> | <code csharp> | ||
| Line 25: | Line 79: | ||
| UserName = "user", | UserName = "user", | ||
| Password = "mypassword", | Password = "mypassword", | ||
| - | SshHostKeyFingerprint = "ssh-rsa 2048 xx:xx:xx:xx:xx:xx:xx:xx..." | + | SshHostKeyFingerprint = "ssh-rsa 2048 xxxxxxxxxxx..." |
| }; | }; | ||
| Line 37: | Line 91: | ||
| // Enumerate files and directories to download | // Enumerate files and directories to download | ||
| + | var opts = WinSCP.EnumerationOptions.EnumerateDirectories | | ||
| + | WinSCP.EnumerationOptions.AllDirectories; | ||
| IEnumerable<RemoteFileInfo> fileInfos = | IEnumerable<RemoteFileInfo> fileInfos = | ||
| - | session.EnumerateRemoteFiles( | + | session.EnumerateRemoteFiles(remotePath, null, opts); |
| - | ························remotePath, null, | + | |
| - | EnumerationOptions.EnumerateDirectories | | + | |
| - | EnumerationOptions.AllDirectories); | + | |
| foreach (RemoteFileInfo fileInfo in fileInfos) | foreach (RemoteFileInfo fileInfo in fileInfos) | ||
| { | { | ||
| string localFilePath = | string localFilePath = | ||
| - | session.TranslateRemotePathToLocal( | + | RemotePath.TranslateRemotePathToLocal( |
| fileInfo.FullName, remotePath, localPath); | fileInfo.FullName, remotePath, localPath); | ||
| Line 61: | Line 114: | ||
| Console.WriteLine("Downloading file {0}...", fileInfo.FullName); | Console.WriteLine("Downloading file {0}...", fileInfo.FullName); | ||
| // Download file | // Download file | ||
| + | string remoteFilePath = RemotePath.EscapeFileMask(fileInfo.FullName); | ||
| TransferOperationResult transferResult = | TransferOperationResult transferResult = | ||
| - | session.GetFiles( | + | session.GetFiles(remoteFilePath, localFilePath); |
| - | session.EscapeFileMask(fileInfo.FullName), localFilePath); | + | |
| // Did the download succeeded? | // Did the download succeeded? | ||
| Line 88: | Line 141: | ||
| </code> | </code> | ||
| - | ===== [[powershell]] PowerShell Example ===== | + | ==== [[powershell]] PowerShell Example ==== |
| <code powershell> | <code powershell> | ||
| Line 94: | Line 147: | ||
| # Use Generate Session URL function to obtain a value for -sessionUrl parameter. | # Use Generate Session URL function to obtain a value for -sessionUrl parameter. | ||
| [Parameter(Mandatory = $True)] | [Parameter(Mandatory = $True)] | ||
| - | $sessionUrl = "sftp://user:mypassword;fingerprint=ssh-rsa-xx-xx-xx@example.com/", | + | $sessionUrl = "sftp://user:mypassword;fingerprint=ssh-rsa-xxxxxxxxxxx...@example.com/", |
| [Parameter(Mandatory = $True)] | [Parameter(Mandatory = $True)] | ||
| $remotePath, | $remotePath, | ||
| Line 128: | Line 181: | ||
| { | { | ||
| $localFilePath = | $localFilePath = | ||
| - | $session.TranslateRemotePathToLocal($fileInfo.FullName, $remotePath, $localPath) | + | [WinSCP.RemotePath]::TranslateRemotePathToLocal( |
| + | ····················$fileInfo.FullName, $remotePath, $localPath) | ||
| if ($fileInfo.IsDirectory) | if ($fileInfo.IsDirectory) | ||
| Line 142: | Line 196: | ||
| Write-Host "Downloading file $($fileInfo.FullName)..." | Write-Host "Downloading file $($fileInfo.FullName)..." | ||
| # Download file | # Download file | ||
| - | $transferResult = | + | $remoteFilePath = [WinSCP.RemotePath]::EscapeFileMask($fileInfo.FullName) |
| - | ···················$session.GetFiles( | + | ···············$transferResult = $session.GetFiles($remoteFilePath, $localFilePath) |
| - | ·······················$session.EscapeFileMask($fileInfo.FullName), $localFilePath) | + | |
| # Did the download succeeded? | # Did the download succeeded? | ||
| Line 172: | Line 225: | ||
| </code> | </code> | ||
| - | ===== Upload ===== | + | ==== Upload ==== |
| - | For an example of walking a local tree to upload files individually, see [[library_example_moves_files_keeping_directory_structure|Recursively move files in directory tree to/from SFTP/FTP server while preserving source directory structure]]. | + | For an example of walking a local tree to upload files individually, see [[library_example_moves_files_keeping_directory_structure|*]]. |
| - | The upload example calls ''[[library_operationresultbase#check|OperationResultBase.Check]]'', so it aborts on any error. Just replace the call with ''[[library_operationresultbase#issuccess|OperationResultBase.IsSuccess]]'' test as this example does. See [[library_session#results|Capturing Results of Operations]] | + | The upload example calls ''[[library_operationresultbase#check|OperationResultBase.Check]]'', so it aborts on any error. Just replace the call with ''[[library_operationresultbase#issuccess|OperationResultBase.IsSuccess]]'' test, as the download example above does. See [[library_session#results|Capturing results of operations]]. |