The CData ADO.NET Provider for SFTP implements a standard DbConnection object in SFTPConnection. You can also use the SFTPConnectionStringBuilder to programmatically build, parse, and rebuild connection strings.

Creating Connection Objects

See Establishing a Connection for guides to defining the connection string and authenticating. Below is a typical invocation to create SFTPConnection objects.

C#

using (SFTPConnection connection =   
  new SFTPConnection("RemoteHost=MySFTPServer;"))  
{  
  connection.Open();  
}

VB.NET

Using connection As New SFTPConnection("RemoteHost=MySFTPServer;")
  connection.Open
End Using

Using SFTPConnectionStringBuilder

The following code example shows how to use an ADO.NET connection string builder to parse a connection string.

C#

SFTPConnectionStringBuilder builder =
  new SFTPConnectionStringBuilder("RemoteHost=MySFTPServer;");
  //Pass the connection string builder an existing connection string, and you can get and set any of the elements as strongly typed properties.
  builder.ConnectionString = "RemoteHost=MySFTPServer;";
  //Now that the connection string has been parsed,
  // you can work with individual items:
  builder.MyString = "new property";
  builder.MyBoolean = true;

  // You can refer to connection keys using strings, 
  // as well. 
  builder["Logfile"] = "test.log";
  builder["Verbosity"] = 5;

VB.NET

Dim builder As SFTPConnectionStringBuilder = New SFTPConnectionStringBuilder("RemoteHost=MySFTPServer;")
'Pass the connection string builder an existing connection string, and you can get and set any of the elements using strongly typed properties.
builder.ConnectionString = RemoteHost=MySFTPServer;"
'Now that the connection string has been parsed,
' you can work with individual items:
builder.MyString = "new property"
builder.MyBoolean = True
  
' You can refer to connection keys using strings, 
' as well. 
builder("Logfile") = "test.log"
builder("Verbosity") = 5