VBScript

Disconnect from an SFTP Server

Demonstrates the Chilkat SFtp.Disconnect method, which closes the current SSH/SFTP connection. It takes no arguments. All remote file and directory handles from the session become invalid and must not be reused.

Background: Disconnecting releases the SSH transport and every SFTP handle opened on it. The object itself stays reusable, but a later session must repeat the full setup — Connect, authenticate, then InitializeSftp — because the SFTP subsystem does not survive a disconnect.

Chilkat VBScript Downloads

Download Chilkat for VBScript

VBScript

Dim fso, outFile
Set fso = CreateObject("Scripting.FileSystemObject")
'Create a Unicode (utf-16) output text file.
Set outFile = fso.CreateTextFile("output.txt", True, True)

success = 0

'  Demonstrates the SFtp.Disconnect method, which closes the current SSH/SFTP connection.  It
'  takes no arguments.  All remote file and directory handles from the session become invalid.

set sftp = CreateObject("Chilkat.SFtp")

'  Step 1: Connect the SSH transport.  Port 22 is the usual port.
port = 22
success = sftp.Connect("sftp.example.com",port)
If (success = 0) Then
    outFile.WriteLine(sftp.LastErrorText)
    WScript.Quit
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.
password = "mySshPassword"

success = sftp.AuthenticatePw("mySshLogin",password)
If (success = 0) Then
    outFile.WriteLine(sftp.LastErrorText)
    WScript.Quit
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 = 0) Then
    outFile.WriteLine(sftp.LastErrorText)
    WScript.Quit
End If

'  ... perform SFTP operations ...

'  Close the connection.  The object remains reusable: a later session must Connect,
'  authenticate, and InitializeSftp again.
sftp.Disconnect 

outFile.Close