Visual FoxPro

Get the Type of an Active SSH Channel

Demonstrates the Chilkat Ssh.GetChannelType method, which returns the type of the channel at a zero-based enumeration index. The only argument is the index — an enumeration position, not a channel number. Values include session, x11, forwarded-tcpip, and direct-tcpip.

Background: Paired with GetChannelNumber, this turns the channel collection into a readable inventory of what a connection is currently doing — which channels are running commands (session) versus tunneling TCP traffic (direct-tcpip). That is valuable for diagnostics and for application code that manages several channel kinds at once. An out-of-range index causes the string-returning method to report failure.

Chilkat Visual FoxPro Downloads

Download Chilkat for Visual FoxPro

Visual FoxPro

LOCAL lnSuccess
LOCAL loSsh
LOCAL lnSshPort
LOCAL lcPassword
LOCAL lnChannelNum
LOCAL n
LOCAL i
LOCAL lnChNum
LOCAL lcChType

lnSuccess = 0

*  Demonstrates the Ssh.GetChannelType method, which returns the type of the channel at a
*  zero-based enumeration index.  The only argument is the index, which is an enumeration
*  position and not a channel number.  Values include "session" and "direct-tcpip".

loSsh = CreateObject('Chilkat.Ssh')

lnSshPort = 22
lnSuccess = loSsh.Connect("ssh.example.com",lnSshPort)
IF (lnSuccess = 0) THEN
    ? loSsh.LastErrorText
    RELEASE loSsh
    CANCEL
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"

lnSuccess = loSsh.AuthenticatePw("mySshLogin",lcPassword)
IF (lnSuccess = 0) THEN
    ? loSsh.LastErrorText
    RELEASE loSsh
    CANCEL
ENDIF

lnChannelNum = loSsh.OpenSessionChannel()
IF (lnChannelNum < 0) THEN
    ? loSsh.LastErrorText
    RELEASE loSsh
    CANCEL
ENDIF

*  Enumerate the active channels and report each one's number and type.
n = loSsh.NumOpenChannels

FOR i = 0 TO n - 1
    lnChNum = loSsh.GetChannelNumber(i)
    lcChType = loSsh.GetChannelType(i)
    IF (loSsh.LastMethodSuccess = 0) THEN
        ? loSsh.LastErrorText
        RELEASE loSsh
        CANCEL
    ENDIF

    ? "Channel " + STR(lnChNum) + " is of type " + lcChType
NEXT

loSsh.Disconnect()

RELEASE loSsh