Lianja

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 Lianja Downloads

Download Chilkat for Lianja

Lianja

llSuccess = .F.

//  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.

loSsh = createobject("CkSsh")

lnSshPort = 22
llSuccess = loSsh.Connect("ssh.example.com",lnSshPort)
if (llSuccess = .F.) then
    ? loSsh.LastErrorText
    release loSsh
    return
endif

//  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.
lcPassword = "mySshPassword"

llSuccess = loSsh.AuthenticatePw("mySshLogin",lcPassword)
if (llSuccess = .F.) then
    ? loSsh.LastErrorText
    release loSsh
    return
endif

lnChannelNum = loSsh.OpenSessionChannel()
if (lnChannelNum < 0) then
    ? loSsh.LastErrorText
    release loSsh
    return
endif

llSuccess = loSsh.SendReqExec(lnChannelNum,"ls -l /tmp")
if (llSuccess = .F.) then
    ? loSsh.LastErrorText
    release loSsh
    return
endif

//  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.
loSsh.ReadTimeoutMs = 15000

llSuccess = loSsh.ChannelReceiveToClose(lnChannelNum)
if (llSuccess = .F.) then
    ? loSsh.LastErrorText
    release loSsh
    return
endif

//  Append the received text to a StringBuilder.  Existing content is preserved.
loSb = createobject("CkStringBuilder")
llSuccess = loSsh.GetReceivedSb(lnChannelNum,"utf-8",loSb)
if (llSuccess = .F.) then
    ? loSsh.LastErrorText
    release loSsh
    release loSb
    return
endif

? "Characters received: " + str(loSb.Length)
lcOutput = loSb.GetAsString()
? lcOutput

loSsh.Disconnect()


release loSsh
release loSb