Objective-C

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 Objective-C Downloads

Download Chilkat for Objective-C

Objective-C

#import <CkoSFtp.h>
#import <NSString.h>

BOOL success = NO;

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

CkoSFtp *sftp = [[CkoSFtp alloc] init];

//  Connect, authenticate, and initialize the SFTP subsystem.
int port = 22;
success = [sftp Connect: @"sftp.example.com" port: [NSNumber numberWithInt: port]];
if (success == NO) {
    NSLog(@"%@",sftp.LastErrorText);
    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.
NSString *password = @"mySshPassword";

success = [sftp AuthenticatePw: @"mySshLogin" password: password];
if (success == NO) {
    NSLog(@"%@",sftp.LastErrorText);
    return;
}

success = [sftp InitializeSftp];
if (success == NO) {
    NSLog(@"%@",sftp.LastErrorText);
    return;
}

//  Open a remote file, obtaining a handle.
NSString *handle = [sftp OpenFile: @"subdir/data.txt" access: @"readOnly" createDisp: @"openExisting"];
if (sftp.LastMethodSuccess == NO) {
    NSLog(@"%@",sftp.LastErrorText);
    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 == NO) {
    NSLog(@"%@",sftp.LastErrorText);
    return;
}

NSLog(@"%@",@"Handle closed.");

[sftp Disconnect];