Xojo Plugin

Initialize the SFTP Subsystem

Demonstrates the Chilkat SFtp.InitializeSftp method, which opens the SFTP subsystem and negotiates the SFTP protocol version. It takes no arguments and must be called after connecting and authenticating, before any file or directory operation.

Background: SFTP is not a standalone protocol but a subsystem requested over an authenticated SSH session, which is why this separate step exists. It is also where the SFTP protocol version is negotiated — that version determines which capabilities (such as certain timestamp and path-composition features) are available for the session. Skipping this call, or calling it before authentication, leaves every file operation failing.

Chilkat Xojo Plugin Downloads

Download Chilkat for Xojo Plugin

Xojo Plugin

Dim success As Boolean
success = False

//  Demonstrates the SFtp.InitializeSftp method, which opens the SFTP subsystem and negotiates the
//  SFTP protocol version.  It takes no arguments and must be called after connecting and
//  authenticating, before any file or directory operations.

Dim sftp As New Chilkat.SFtp

//  Step 1: Connect the SSH transport.  Port 22 is the usual port.
Dim port As Int32
port = 22
success = sftp.Connect("sftp.example.com",port)
If (success = False) Then
    System.DebugLog(sftp.LastErrorText)
    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.
Dim password As String
password = "mySshPassword"

success = sftp.AuthenticatePw("mySshLogin",password)
If (success = False) Then
    System.DebugLog(sftp.LastErrorText)
    Return
End If

//  Step 3: Open the SFTP subsystem.  This must be done after authentication and before any
//  file or directory operations.
success = sftp.InitializeSftp()
If (success = False) Then
    System.DebugLog(sftp.LastErrorText)
    Return
End If

System.DebugLog("The SFTP subsystem is ready.")

sftp.Disconnect