SFTP Read Text File to String

Demonstrates how to download a text file from an SSH server directly into a string variable.

Download: Chilkat .NET Assemblies

//  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 on the server:
string handle;
handle = sftp.OpenFile("hamlet.xml","readOnly","openExisting");
if (handle == null ) {
    MessageBox.Show(sftp.LastErrorText);
    return;
}

//  Get the total size of this file (in bytes)
bool bFollowLinks;
bFollowLinks = false;
bool bIsHandle;
bIsHandle = true;
int numBytes;

//  bFollowLinks is ignored because we are passing a handle
//  and not a remote filename.
//  There are atlernative methods for handling file sizes
//  greater than 32-bit.  (See the reference documentation.)
numBytes = sftp.GetFileSize32(handle,bFollowLinks,bIsHandle);
if (numBytes < 0) {
    MessageBox.Show(sftp.LastErrorText);
    return;
}

//  The charset indicates the character encoding of the text
//  file on the SSH server.   Setting the charset correctly
//  allows the Chilkat SFTP component to correctly interpret
//  the bytes that represent the characters.
string charset;
charset = "ansi";
int offset32;
offset32 = 0;
string fileContents;
fileContents = sftp.ReadFileText32(handle,offset32,numBytes,charset);
if (fileContents == null ) {
    MessageBox.Show(sftp.LastErrorText);
    return;
}
else {
    textBox1.Text += "Received file:" + "\r\n";
    textBox1.Text += fileContents + "\r\n";
}

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

MessageBox.Show("Success.");