Close a Remote SFTP File or Directory Handle

See more SFTP Examples

Demonstrates the Chilkat SFtp.CloseHandle method, which closes a remote file or directory handle previously returned by OpenFile or OpenDir. The only argument is the handle.

Background: Every opened handle corresponds to state the server holds, and servers cap how many a session may keep open at once, so a long-running program that forgets to close handles will eventually start failing to open new ones. Closing also ensures buffered writes are committed. Once closed, a handle is invalid and must not be reused.

Chilkat Go Downloads

Download Chilkat for Go

    success := false

    //  Demonstrates the SFtp.CloseHandle method, which closes a remote file or directory handle.  The
    //  only argument is the handle returned by OpenFile or OpenDir.

    sftp := chilkat.NewSFtp()

    //  Connect, authenticate, and initialize the SFTP subsystem.
    port := 22
    success = sftp.Connect("sftp.example.com",port)
    if success == false {
        fmt.Println(sftp.LastErrorText())
        sftp.DisposeSFtp()
        return
    }

    //  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 == false {
        fmt.Println(sftp.LastErrorText())
        sftp.DisposeSFtp()
        return
    }

    success = sftp.InitializeSftp()
    if success == false {
        fmt.Println(sftp.LastErrorText())
        sftp.DisposeSFtp()
        return
    }

    //  Open a remote file, obtaining a handle.
    handle := sftp.OpenFile("subdir/data.txt","readOnly","openExisting")
    if sftp.LastMethodSuccess() == false {
        fmt.Println(sftp.LastErrorText())
        sftp.DisposeSFtp()
        return
    }

    //  ... use the handle ...

    //  Close the handle to release the server-side resource.  A handle should not be used after it
    //  is closed.
    success = sftp.CloseHandle(*handle)
    if success == false {
        fmt.Println(sftp.LastErrorText())
        sftp.DisposeSFtp()
        return
    }

    fmt.Println("Handle closed.")

    sftp.Disconnect()

    sftp.DisposeSFtp()