Lianja

Close a Remote SFTP File or Directory Handle

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 Lianja Downloads

Download Chilkat for Lianja

Lianja

llSuccess = .F.

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

loSftp = createobject("CkSFtp")

//  Connect, authenticate, and initialize the SFTP subsystem.
lnPort = 22
llSuccess = loSftp.Connect("sftp.example.com",lnPort)
if (llSuccess = .F.) then
    ? loSftp.LastErrorText
    release loSftp
    return
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"

llSuccess = loSftp.AuthenticatePw("mySshLogin",lcPassword)
if (llSuccess = .F.) then
    ? loSftp.LastErrorText
    release loSftp
    return
endif

llSuccess = loSftp.InitializeSftp()
if (llSuccess = .F.) then
    ? loSftp.LastErrorText
    release loSftp
    return
endif

//  Open a remote file, obtaining a handle.
lcHandle = loSftp.OpenFile("subdir/data.txt","readOnly","openExisting")
if (loSftp.LastMethodSuccess = .F.) then
    ? loSftp.LastErrorText
    release loSftp
    return
endif

//  ... use the handle ...

//  Close the handle to release the server-side resource.  A handle should not be used after it
//  is closed.
llSuccess = loSftp.CloseHandle(lcHandle)
if (llSuccess = .F.) then
    ? loSftp.LastErrorText
    release loSftp
    return
endif

? "Handle closed."

loSftp.Disconnect()


release loSftp