Unicode C++

Get Received SSH Text into a StringBuilder

Demonstrates the Chilkat Ssh.GetReceivedSb method, which decodes a channel's receive buffer and appends the text to a StringBuilder. The arguments are the channel number, the charset, and the StringBuilder. The receive buffer is cleared afterward.

Background: Because this appends rather than replaces, it is the natural choice for accumulating output across repeated reads — call it in a loop and the StringBuilder grows into the complete transcript. It also avoids creating a new string on every retrieval, which matters when a command produces a large amount of text.

Chilkat Unicode C++ Downloads

Download Chilkat for Unicode C++

Unicode C++

#include <CkSshW.h>
#include <CkStringBuilderW.h>

void ChilkatSample(void)
    {
    bool success = false;

    //  Demonstrates the Ssh.GetReceivedSb method, which decodes the channel's receive buffer and
    //  appends the text to a StringBuilder.  The 1st argument is the channel number, the 2nd is the
    //  charset, and the 3rd is the StringBuilder.  The receive buffer is cleared afterward.

    CkSshW ssh;

    int sshPort = 22;
    success = ssh.Connect(L"ssh.example.com",sshPort);
    if (success == false) {
        wprintf(L"%s\n",ssh.lastErrorText());
        return;
    }

    //  Normally you would not hard-code the password in source.  You should instead obtain it
    //  from an interactive prompt, environment variable, or a secrets vault.
    const wchar_t *password = L"mySshPassword";

    success = ssh.AuthenticatePw(L"mySshLogin",password);
    if (success == false) {
        wprintf(L"%s\n",ssh.lastErrorText());
        return;
    }

    int channelNum = ssh.OpenSessionChannel();
    if (channelNum < 0) {
        wprintf(L"%s\n",ssh.lastErrorText());
        return;
    }

    success = ssh.SendReqExec(channelNum,L"ls -l /tmp");
    if (success == false) {
        wprintf(L"%s\n",ssh.lastErrorText());
        return;
    }

    //  IMPORTANT: Set a read timeout.  ReadTimeoutMs defaults to 0, which means no limit -- without
    //  it, this call waits forever if the server never sends channel close.
    ssh.put_ReadTimeoutMs(15000);

    success = ssh.ChannelReceiveToClose(channelNum);
    if (success == false) {
        wprintf(L"%s\n",ssh.lastErrorText());
        return;
    }

    //  Append the received text to a StringBuilder.  Existing content is preserved.
    CkStringBuilderW sb;
    success = ssh.GetReceivedSb(channelNum,L"utf-8",sb);
    if (success == false) {
        wprintf(L"%s\n",ssh.lastErrorText());
        return;
    }

    wprintf(L"Characters received: %d\n",sb.get_Length());
    const wchar_t *output = sb.getAsString();
    wprintf(L"%s\n",output);

    ssh.Disconnect();
    }