Differences
This shows you the differences between the selected revisions of the page.
| library 2015-07-07 | library 2024-10-03 (current) | ||
| Line 1: | Line 1: | ||
| ====== WinSCP .NET Assembly and COM Library ====== | ====== WinSCP .NET Assembly and COM Library ====== | ||
| - | The WinSCP .NET assembly ''winscpnet.dll'' is a .NET wrapper around WinSCP's [[scripting|scripting interface]] that allows your code to connect to a remote machine and manipulate remote files over SFTP, FTP, WebDAV and SCP sessions from .NET languages, such as [[#csharp|C#]], [[#vbnet|VB.NET]], and others, or from environments supporting .NET, such as [[library_powershell|PowerShell]], [[library_ssis|SQL Server Integration Services (SSIS)]], ASP.NET and Microsoft Azure WebSite. | + | The WinSCP .NET assembly ''winscpnet.dll'' is a .NET wrapper around WinSCP's [[scripting|scripting interface]] that allows your code to connect to a remote machine and manipulate remote files over SFTP, FTP, WebDAV, S3 and SCP sessions from .NET languages, such as [[#csharp|C#]], [[#vbnet|VB.NET]], and others, or from automation environments supporting .NET, such as [[library_powershell|PowerShell]], [[library_ssis|SQL Server Integration Services (SSIS)]] and Microsoft Azure WebSites and Functions. |
| The assembly is also exposed to COM, and as such it can be used from variety of other programming languages and development environments--e.g., [[library_com_wsh|WSH-hosted active scripting languages]] like JScript and VBScript, [[library_vb|Visual Basic for Applications (VBA)]], [[library_perl|Perl]], and Python. | The assembly is also exposed to COM, and as such it can be used from variety of other programming languages and development environments--e.g., [[library_com_wsh|WSH-hosted active scripting languages]] like JScript and VBScript, [[library_vb|Visual Basic for Applications (VBA)]], [[library_perl|Perl]], and Python. | ||
| - | The library is primarily intended for advanced automation tasks that require conditional processing, loops or other control structures for which the basic [[scripting|scripting interface]] is too limited. The library is not a general purpose file transfer library. It particularly lacks support for interactive processing and as such it is not well suited for use in GUI applications. | + | The assembly targets .NET Framework 4.0 and .NET Standard 2.0. |
| - | You can write a script using the assembly that [[guide_custom_commands_automation|extends functionality of WinSCP GUI]]. | + | ===== [[purpose]] Purpose of the Assembly ===== |
| - | == Hacked By $corpion Team == | + | The library is primarily intended for advanced automation tasks on Microsoft Windows that require conditional processing, loops or other control structures for which the basic [[scripting|scripting interface]] is too limited. |
| + | You can also use the assembly to write scripts that [[guide_custom_commands_automation|extend functionality of WinSCP GUI]]. | ||
| + | The library is not a general purpose file transfer library. It particularly has a limited support for an interactive processing, and as such it is not well suited for use in GUI applications. | ||
| - | **Red $corpion** | + | Because the assembly uses ''winscp.exe'' internally, it is also difficult (but not impossible) to use the assembly within a restricted environment like a ==web== server (e.g. with ASP.NET), that limits or even restricts execution of external processes. |
| - | == Hacked By $corpion Team == | + | ===== Downloading and Installing the Assembly ===== |
| + | First you need to [[library_install|download and install the assembly]]. | ||
| + | ===== [[using]] Using Classes from WinSCP .NET Assembly ===== | ||
| + | - Create an instance of the ''[[library_sessionoptions|WinSCP.SessionOptions]]'' class and fill in all necessary information to allow an automatic connection and authentication of your session. | ||
| + | - Create an instance of the ''[[library_session|WinSCP.Session]]'' class. Optionally you can hook handlers of some events of the class. | ||
| + | - Open the session using ''[[library_session_open|Session.Open]]'' method, passing instance of your ''WinSCP.SessionOptions''. | ||
| + | Once the session is opened, you can use any of the ''WinSCP.Session'' [[library_session#methods|methods]] to manipulate remote files, e.g., | ||
| + | * ''[[library_session_getfiles|Session.GetFiles]]'' to [[task_download|download files]], | ||
| + | * ''[[library_session_putfiles|Session.PutFiles]]'' to [[task_upload|upload files]] or | ||
| + | * ''[[library_session_synchronizedirectories|Session.SynchronizeDirectories]]'' to [[task_synchronize_full|synchronize directories]]. | ||
| - | **Red $corpion** | + | ===== [[classes]] Classes ===== |
| - | + | ||
| - | ===== Classes ===== | + | |
| Namespace: ''WinSCP'' | Namespace: ''WinSCP'' | ||
| Line 26: | Line 35: | ||
| | [[library_chmodeventargs|ChmodEventArgs]] | Provides data for change of permissions event. | | | [[library_chmodeventargs|ChmodEventArgs]] | Provides data for change of permissions event. | | ||
| | [[library_commandexecutionresult|CommandExecutionResult]] | Represents results of [[library_session_executecommand|Session.ExecuteCommand]]. | | | [[library_commandexecutionresult|CommandExecutionResult]] | Represents results of [[library_session_executecommand|Session.ExecuteCommand]]. | | ||
| + | | [[library_comparisondifference|ComparisonDifference]] | Represents data about a single difference identified by [[library_session_comparedirectories|''Session.CompareDirectories'']]. | | ||
| | [[library_failedeventargs|FailedEventArgs]] | Provides data for ''[[library_session_failed|Session.Failed]]'' event. | | | [[library_failedeventargs|FailedEventArgs]] | Provides data for ''[[library_session_failed|Session.Failed]]'' event. | | ||
| | [[library_fileoperationeventargs|FileOperationEventArgs]] | Provides data for abstract file operation event. | | | [[library_fileoperationeventargs|FileOperationEventArgs]] | Provides data for abstract file operation event. | | ||
| Line 34: | Line 44: | ||
| | [[library_remotedirectoryinfo|RemoteDirectoryInfo]] | Represents data about remote directory. | | | [[library_remotedirectoryinfo|RemoteDirectoryInfo]] | Represents data about remote directory. | | ||
| | [[library_remotefileinfo|RemoteFileInfo]] | Represents data about remote file. | | | [[library_remotefileinfo|RemoteFileInfo]] | Represents data about remote file. | | ||
| + | | [[library_remotepath|RemotePath]] | Performs operations on ''string'' instances that contain file or directory path. | | ||
| | [[library_removaleventargs|RemovalEventArgs]] | Provides data for remote file removal event. | | | [[library_removaleventargs|RemovalEventArgs]] | Provides data for remote file removal event. | | ||
| | [[library_removaloperationresult|RemovalOperationResult]] | Represents results of file removal (''[[library_session_removefiles|Session.RemoveFiles]]''). | | | [[library_removaloperationresult|RemovalOperationResult]] | Represents results of file removal (''[[library_session_removefiles|Session.RemoveFiles]]''). | | ||
| Line 48: | Line 59: | ||
| | [[library_transferresumesupport|TransferResumeSupport]] | Configures automatic resume/transfer to temporary filename. | | | [[library_transferresumesupport|TransferResumeSupport]] | Configures automatic resume/transfer to temporary filename. | | ||
| - | == Hacked By $corpion Team ==· | + | ===== Generating Code ===== |
| + | You can have WinSCP [[ui_generateurl|generate a code template for you]]. | ||
| + | ===== [[example]] Examples ===== | ||
| - | **Red $corpion** | + | See [[library_examples|list of all examples]]. |
| ==== [[csharp]] C# Example ==== | ==== [[csharp]] C# Example ==== | ||
| Line 68: | Line 81: | ||
| { | { | ||
| // Setup session options | // Setup session options | ||
| - | SessionOptions sessionOptions = new SessionOptions { | + | SessionOptions sessionOptions = new SessionOptions |
| + | ···········{ | ||
| Protocol = Protocol.Sftp, | Protocol = Protocol.Sftp, | ||
| HostName = "example.com", | HostName = "example.com", | ||
| UserName = "user", | UserName = "user", | ||
| Password = "mypassword", | Password = "mypassword", | ||
| - | SshHostKeyFingerprint = "ssh-rsa 2048 xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx" | + | SshHostKeyFingerprint = "ssh-rsa 2048 xxxxxxxxxxx..." |
| }; | }; | ||
| Line 86: | Line 100: | ||
| TransferOperationResult transferResult; | TransferOperationResult transferResult; | ||
| - | transferResult = session.PutFiles(@"d:\toupload\*", "/home/user/", false, transferOptions); | + | transferResult = |
| + | ···················session.PutFiles(@"d:\toupload\*", "/home/user/", false, transferOptions); | ||
| // Throw on any error | // Throw on any error | ||
| Line 109: | Line 124: | ||
| </code> | </code> | ||
| - | == Hacked By $corpion Team == | + | ==== [[vbnet]] VB.NET Example ==== |
| + | There are also [[library_examples|other VB.NET examples]]. | ||
| + | <code vbnet> | ||
| + | Imports WinSCP | ||
| + | Friend Class Example | ||
| - | **Red $corpion** | + | ····Public Shared Function Main() As Integer |
| - | ==== [[powershell]] PowerShell Example ==== | + | ········Try |
| - | See [[library_powershell#example|overall PowerShell example]] or [[library_examples|any other PowerShell example]]. | + | ············' Setup session options |
| + | ············Dim sessionOptions As New SessionOptions | ||
| + | ············With sessionOptions | ||
| + | .Protocol = Protocol.Sftp | ||
| + | .HostName = "example.com" | ||
| + | .UserName = "user" | ||
| + | ···············.Password = "mypassword" | ||
| + | .SshHostKeyFingerprint = "ssh-rsa 2048 xxxxxxxxxxx..." | ||
| + | End With | ||
| - | == Hacked By $corpion Team == | + | ············Using session As New Session |
| + | ' Connect | ||
| + | session.Open(sessionOptions) | ||
| + | ' Upload files | ||
| + | Dim transferOptions As New TransferOptions | ||
| + | transferOptions.TransferMode = TransferMode.Binary | ||
| + | Dim transferResult As TransferOperationResult | ||
| + | transferResult = | ||
| + | session.PutFiles("d:\toupload\*", "/home/user/", False, transferOptions) | ||
| - | **Red $corpion** | + | ················' Throw on any error |
| + | transferResult.Check() | ||
| - | ==== [[vbscript]] VBScript Example ==== | + | ················' Print results |
| - | See [[library_com_wsh#vbscript|overall VBScript example]] or [[library_examples|any other VBScript example]]. | + | ················For Each transfer In transferResult.Transfers |
| + | ···················Console.WriteLine("Upload of {0} succeeded", transfer.FileName) | ||
| + | ···············Next | ||
| + | ············End Using | ||
| - | == Hacked By $corpion Team == | + | ············Return 0 |
| + | Catch e As Exception | ||
| + | Console.WriteLine("Error: {0}", e) | ||
| + | Return 1 | ||
| + | End Try | ||
| + | End Function | ||
| + | End Class | ||
| + | </code> | ||
| - | **Red $corpion** | + | ==== [[powershell]] PowerShell Example ==== |
| + | See [[library_powershell#example|overall PowerShell example]] or [[library_examples|any other PowerShell example]]. | ||
| - | ==== [[perl]] Perl Example ==== | + | ==== [[jscript]] JScript Example ==== |
| - | See [[library_perl#example|overall Perl example]]. | + | See [[library_com_wsh#jscript|overall JScript example]] or [[library_examples|any other JScript example]]. |
| - | == Hacked By $corpion Team == | + | ==== [[vbscript]] VBScript Example ==== |
| + | See [[library_com_wsh#vbscript|overall VBScript example]] or [[library_examples|any other VBScript example]]. | ||
| + | ==== [[vba]] VBA Example ==== | ||
| + | See [[library_vb#example|overall VBA example]]. | ||
| + | ==== [[perl]] Perl Example ==== | ||
| + | See [[library_perl#example|overall Perl example]]. | ||
| - | **Red $corpion** | + | ==== [[ssis]] SSIS Example ==== |
| + | See [[library_ssis#example|overall SSIS example]]. | ||
| ===== [[net]] Converting Script to Code Based on .NET Assembly ===== | ===== [[net]] Converting Script to Code Based on .NET Assembly ===== | ||
| Line 146: | Line 199: | ||
| ===== [[license]] License ===== | ===== [[license]] License ===== | ||
| - | The WinSCP .NET Assembly is a free library: you can use it, redistribute it and/or modify it under the terms of the [[http://www.mozilla.org/MPL/2.0/|Mozilla Public License Version 2.0]]. | + | The WinSCP .NET Assembly is a free library: you can use it, redistribute it and/or modify it under the terms of the [[https://www.mozilla.org/MPL/2.0/|Mozilla Public License Version 2.0]]. |
| - | Note that [[library_install#installing|the assembly interacts with WinSCP executable]], which uses a [[license|different license, the GPL]]. Though as WinSCP is used as an executable, via its public [[scripting|scripting interface]], not as a library, all you need to do to comply with the GPL license, is to keep %%GPL%% license file around.((Simply said, keep all files from ''winscpXXXautomation.zip'' package together.)) | + | Because WinSCP uses [[license|the GPL license]] it's important to keep the %%GPL%% license file around.((Simply said, keep all files from ''WinSCP-X.X.X-Automation.zip'' package together.)) Your software doesn't have to be licensed under GPL as the WinSCP .NET Assembly is using WinSCP as an executable, via its public [[scripting|scripting interface]], and not as a library. |