Differences
This shows you the differences between the selected revisions of the page.
| guide_dotnet 2014-03-07 | guide_dotnet 2020-12-25 (current) | ||
| Line 4: | Line 4: | ||
| //This guide describes how to implement SFTP transfer in .NET application using WinSCP.// | //This guide describes how to implement SFTP transfer in .NET application using WinSCP.// | ||
| - | WinSCP is SFTP client with [[scripting]] interface that you can use to automate many operations that it supports, including file transfers, synchronization and other. So WinSCP itself is not a library (e.g. [[library|.NET assembly]]) that you can call directly. Though this guides shows you how to use it seamlessly from the .NET code. | + | WinSCP is SFTP client with [[scripting]] interface that you can use to automate many operations that it supports, including file transfers, synchronization and other. So WinSCP itself is not a library (e.g. [[library|.NET assembly]]) that you can call directly. Though this guide shows you how to use it seamlessly from the .NET code. |
| + | |||
| + | ===== Before Starting ===== | ||
| Before starting you should: | Before starting you should: | ||
| Line 12: | Line 14: | ||
| ===== Using WinSCP from .NET Code ===== | ===== Using WinSCP from .NET Code ===== | ||
| + | |||
| ==== [[running]] Running WinSCP Process ==== | ==== [[running]] Running WinSCP Process ==== | ||
| To run ''[[executables|winscp.com]]'' use ''[[dotnet>system.diagnostics.process|System.Diagnostics.Process]]''. This class allows running any executable, possibly redirecting its standard input and output to a stream accessible from .NET code. Code below expects that ''winscp.com'' (''[[dotnet>system.diagnostics.processstartinfo.filename|ProcessStartInfo.FileName]]'') can be found in current working directory or in search path. You need to provide full path otherwise. | To run ''[[executables|winscp.com]]'' use ''[[dotnet>system.diagnostics.process|System.Diagnostics.Process]]''. This class allows running any executable, possibly redirecting its standard input and output to a stream accessible from .NET code. Code below expects that ''winscp.com'' (''[[dotnet>system.diagnostics.processstartinfo.filename|ProcessStartInfo.FileName]]'') can be found in current working directory or in search path. You need to provide full path otherwise. | ||
| Line 42: | Line 45: | ||
| While you can redirect standard output of WinSCP process, it is actually not very useful, as output of WinSCP does not have any predefined form (cannot be parsed). Though it can be useful to capture it, in case you want to show it to a user in your GUI or for diagnostic purposes. | While you can redirect standard output of WinSCP process, it is actually not very useful, as output of WinSCP does not have any predefined form (cannot be parsed). Though it can be useful to capture it, in case you want to show it to a user in your GUI or for diagnostic purposes. | ||
| - | If you want to collect the output, redirect the standard output before starting WinSCP (''[[dotnet>system.diagnostics.processstartinfo.redirectstandardoutput|ProcessStartInfo.RedirectStandardOutput]]'') and read from output stream (''[[dotnet>system.diagnostics.process.standardoutput|Process.StandardOutput]]''). You need to continously collect the output while the script is running. The output stream has limited capacity. Once it gets filled, WinSCP hangs waiting for free space, never finishing. That means you cannot use ''[[dotnet>system.diagnostics.process.waitforexit|Process.WaitForExit]]'' on its own to wait for script to finish. Convenient alternative is ''[[dotnet>system.io.streamreader.readtoend|StreamReader.ReadToEnd]]'': | + | If you want to collect the output, redirect the standard output before starting WinSCP (''[[dotnet>system.diagnostics.processstartinfo.redirectstandardoutput|ProcessStartInfo.RedirectStandardOutput]]'') and read from output stream (''[[dotnet>system.diagnostics.process.standardoutput|Process.StandardOutput]]''). You need to continuously collect the output while the script is running. The output stream has limited capacity. Once it gets filled, WinSCP hangs waiting for free space, never finishing. That means you cannot use ''[[dotnet>system.diagnostics.process.waitforexit|Process.WaitForExit]]'' on its own to wait for script to finish. Convenient alternative is ''[[dotnet>system.io.streamreader.readtoend|StreamReader.ReadToEnd]]'': |
| <code csharp> | <code csharp> | ||
| winscp.StartInfo.RedirectStandardOutput = true; | winscp.StartInfo.RedirectStandardOutput = true; | ||
| Line 50: | Line 53: | ||
| ==== [[log]] Using log file ===== | ==== [[log]] Using log file ===== | ||
| - | To capture results of script, you can use [[logging_xml|XML logging]]. For this you need to instruct WinSCP to store log file using ''/xmllog'' [[commandline|command-line parameter]] (''[[dotnet>system.diagnostics.processstartinfo.arguments|ProcessStartInfo.Arguments]]''). | + | To capture results of script, you can use [[logging_xml|XML logging]]. For this you need to instruct WinSCP to store log file using ''[[commandline#logging|/xmllog]]'' command-line parameter (''[[dotnet>system.diagnostics.processstartinfo.arguments|ProcessStartInfo.Arguments]]''). |
| <code csharp> | <code csharp> | ||
| Line 60: | Line 63: | ||
| </code> | </code> | ||
| - | Note that before you can safely start reading and parsing the XML log file using tree-based parser (such as ''[[dotnet>system.xml.xmldocument|XmlDocument]]'' or ''[[dotnet>system.xml.xpath.xpathdocument|XPathDocument]]''), you need to [[guide_dotnet#exit|wait for WinSCP to finish]]. See example below. | + | Note that before you can safely start reading and parsing the XML log file using tree-based parser (such as ''[[dotnet>system.xml.xmldocument|XmlDocument]]'' or ''[[dotnet>system.xml.xpath.xpathdocument|XPathDocument]]''), you need to [[#exit|wait for WinSCP to finish]]. See example below. |
| If you need to read the log file continuously, you need to use stream-based parser (such as ''[[dotnet>system.xml.xmlreader|XmlReader]]''). See [[guide_interpreting_xml_log#continuous|example]]. | If you need to read the log file continuously, you need to use stream-based parser (such as ''[[dotnet>system.xml.xmlreader|XmlReader]]''). See [[guide_interpreting_xml_log#continuous|example]]. | ||
| Line 86: | Line 89: | ||
| <code csharp> | <code csharp> | ||
| XPathNodeIterator files = nav.Select("//w:file", ns); | XPathNodeIterator files = nav.Select("//w:file", ns); | ||
| - | Console.WriteLine(string.Format("There are {0} files and subdirectories:", files.Count)); | + | Console.WriteLine("There are {0} files and subdirectories:", files.Count); |
| foreach (XPathNavigator file in files) | foreach (XPathNavigator file in files) | ||
| { | { | ||
| Line 93: | Line 96: | ||
| </code> | </code> | ||
| - | //See also guide to [[guide_interpreting_xml_log|interpreting XML log for advanced scripting]].// | + | //See also guide to [[guide_interpreting_xml_log|*]].// |
| ==== [[exit]] Waiting for script to complete ==== | ==== [[exit]] Waiting for script to complete ==== | ||
| Use ''[[dotnet>system.diagnostics.process.waitforexit|Process.WaitForExit]]'' to wait for WinSCP process to finish. | Use ''[[dotnet>system.diagnostics.process.waitforexit|Process.WaitForExit]]'' to wait for WinSCP process to finish. | ||
| - | If you have output stream redirected, you need to first [[guide_dotnet#output|read the output stream to the end]]. | + | If you have output stream redirected, you need to first [[#output|read the output stream to the end]]. |
| A good practice is to close input stream too, if you have it redirected. | A good practice is to close input stream too, if you have it redirected. | ||
| Line 187: | Line 190: | ||
| XPathNodeIterator files = nav.Select("//w:file", ns); | XPathNodeIterator files = nav.Select("//w:file", ns); | ||
| - | Console.WriteLine(string.Format("There are {0} files and subdirectories:", files.Count)); | + | Console.WriteLine("There are {0} files and subdirectories:", files.Count); |
| foreach (XPathNavigator file in files) | foreach (XPathNavigator file in files) | ||
| { | { | ||
| Line 257: | Line 260: | ||
| Dim files As XPathNodeIterator = nav.Select("//w:file", ns) | Dim files As XPathNodeIterator = nav.Select("//w:file", ns) | ||
| - | Console.WriteLine(string.Format("There are {0} files and subdirectories:", files.Count)) | + | Console.WriteLine("There are {0} files and subdirectories:", files.Count) |
| For Each file As XPathNavigator In files | For Each file As XPathNavigator In files | ||
| Console.WriteLine(file.SelectSingleNode("w:filename/@value", ns).Value) | Console.WriteLine(file.SelectSingleNode("w:filename/@value", ns).Value) | ||