PowerBuilder

Get Text Received on an SSH Channel

Demonstrates the Chilkat Ssh.GetReceivedText method, which decodes and returns all text currently accumulated in a channel's normal receive buffer. The first argument is the channel number and the second is the charset. The receive buffer is cleared after the text is returned.

Background: This is the retrieval half of the read-then-get pattern: a Channel* read or receive call fills the buffer, and this hands you the text. Because the buffer is cleared on retrieval, each call returns only what arrived since the last one. A valid channel with nothing buffered returns an empty string successfully, so an empty result is not an error. Retrieve text promptly after a channel completes, before other SSH operations can discard the completed channel record.

Chilkat PowerBuilder Downloads

Download Chilkat for PowerBuilder

PowerBuilder

integer li_rc
integer li_Success
oleobject loo_Ssh
integer li_SshPort
string ls_Password
integer li_ChannelNum
string ls_Output

li_Success = 0

//  Demonstrates the Ssh.GetReceivedText method, which decodes and returns all text currently in
//  a channel's normal receive buffer.  The 1st argument is the channel number and the 2nd is the
//  charset.  The receive buffer is cleared after the text is returned.

loo_Ssh = create oleobject
li_rc = loo_Ssh.ConnectToNewObject("Chilkat.Ssh")
if li_rc < 0 then
    destroy loo_Ssh
    MessageBox("Error","Connecting to COM object failed")
    return
end if

li_SshPort = 22
li_Success = loo_Ssh.Connect("ssh.example.com",li_SshPort)
if li_Success = 0 then
    Write-Debug loo_Ssh.LastErrorText
    destroy loo_Ssh
    return
end if

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

li_Success = loo_Ssh.AuthenticatePw("mySshLogin",ls_Password)
if li_Success = 0 then
    Write-Debug loo_Ssh.LastErrorText
    destroy loo_Ssh
    return
end if

li_ChannelNum = loo_Ssh.OpenSessionChannel()
if li_ChannelNum < 0 then
    Write-Debug loo_Ssh.LastErrorText
    destroy loo_Ssh
    return
end if

li_Success = loo_Ssh.SendReqExec(li_ChannelNum,"cat /etc/hostname")
if li_Success = 0 then
    Write-Debug loo_Ssh.LastErrorText
    destroy loo_Ssh
    return
end if

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

li_Success = loo_Ssh.ChannelReceiveToClose(li_ChannelNum)
if li_Success = 0 then
    Write-Debug loo_Ssh.LastErrorText
    destroy loo_Ssh
    return
end if

//  Retrieve the accumulated output.  A valid channel with no buffered data returns an empty
//  string successfully.
ls_Output = loo_Ssh.GetReceivedText(li_ChannelNum,"utf-8")
if loo_Ssh.LastMethodSuccess = 0 then
    Write-Debug loo_Ssh.LastErrorText
    destroy loo_Ssh
    return
end if

Write-Debug ls_Output

loo_Ssh.Disconnect()


destroy loo_Ssh