PHP Extension

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 PHP Extension Downloads

Download Chilkat for PHP Extension

PHP Extension

<?php

include("chilkat.php");

$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 = new CkSFtp();

//  Connect, authenticate, and initialize the SFTP subsystem.
$port = 22;
$success = $sftp->Connect('sftp.example.com',$port);
if ($success == false) {
    print $sftp->lastErrorText() . "\n";
    exit;
}

//  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) {
    print $sftp->lastErrorText() . "\n";
    exit;
}

$success = $sftp->InitializeSftp();
if ($success == false) {
    print $sftp->lastErrorText() . "\n";
    exit;
}

//  Open a remote file, obtaining a handle.
$handle = $sftp->openFile('subdir/data.txt','readOnly','openExisting');
if ($sftp->get_LastMethodSuccess() == false) {
    print $sftp->lastErrorText() . "\n";
    exit;
}

//  ... 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) {
    print $sftp->lastErrorText() . "\n";
    exit;
}

print 'Handle closed.' . "\n";

$sftp->Disconnect();

?>