SFTP Read Text File

Demonstrates how to open a text file on the SSH server and read text.

Download Chilkat .NET for 4.0 Framework

Download Chilkat .NET for 64-bit 4.0 Framework (x64)

Download Chilkat .NET for 2.0 / 3.5 Framework

Download Chilkat .NET for 64-bit 2.0 / 3.5 Framework (x64)

Download Chilkat .NET for 1.0 / 1.1 Framework

//  Important: It is helpful to send the contents of the
//  sftp.LastErrorText property when requesting support.

Chilkat.SFtp sftp = new Chilkat.SFtp();

//  Any string automatically begins a fully-functional 30-day trial.
bool success;
success = sftp.UnlockComponent("Anything for 30-day trial");
if (success != true) {
    MessageBox.Show(sftp.LastErrorText);
    return;
}

//  Set some timeouts, in milliseconds:
sftp.ConnectTimeoutMs = 5000;
sftp.IdleTimeoutMs = 15000;

//  Connect to the SSH server.
//  The standard SSH port = 22
//  The hostname may be a hostname or IP address.
int port;
string hostname;
hostname = "www.my-ssh-server.com";
port = 22;
success = sftp.Connect(hostname,port);
if (success != true) {
    MessageBox.Show(sftp.LastErrorText);
    return;
}

//  Authenticate with the SSH server.  Chilkat SFTP supports
//  both password-based authenication as well as public-key
//  authentication.  This example uses password authenication.
success = sftp.AuthenticatePw("myLogin","myPassword");
if (success != true) {
    MessageBox.Show(sftp.LastErrorText);
    return;
}

//  After authenticating, the SFTP subsystem must be initialized:
success = sftp.InitializeSftp();
if (success != true) {
    MessageBox.Show(sftp.LastErrorText);
    return;
}

//  Open a file for reading.
string handle;
handle = sftp.OpenFile("myTest.txt","readOnly","openExisting");
if (handle == null ) {
    MessageBox.Show(sftp.LastErrorText);
    return;
}

//  Assume the file we are reading contains the following text:
//  abcdefghijklmnopqrstuvwxyz1234567890ABCDEFGHIJKLMNOPQRSTUVWXYZ
//  (in ANSI format -- i.e. one byte per char).

//  Read 26 bytes:
string sText;
sText = sftp.ReadFileText(handle,26,"ansi");
if (success != true) {
    MessageBox.Show(sftp.LastErrorText);
    return;
}

//  Should print "abcdefghijklmnopqrstuvwxyz"
textBox1.Text += sText + "\r\n";

//  Read the next 10 bytes.
sText = sftp.ReadFileText(handle,10,"ansi");
if (success != true) {
    MessageBox.Show(sftp.LastErrorText);
    return;
}

//  Should print "1234567890"
textBox1.Text += sText + "\r\n";

//  Read the next 26 bytes.
sText = sftp.ReadFileText(handle,26,"ansi");
if (success != true) {
    MessageBox.Show(sftp.LastErrorText);
    return;
}

//  Should print "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
textBox1.Text += sText + "\r\n";

//  Close the file.
success = sftp.CloseHandle(handle);
if (success != true) {
    MessageBox.Show(sftp.LastErrorText);
    return;
}

MessageBox.Show("Success.");