Objective-C

SFTP Get Size of File on Server

See more SFTP Examples

Demonstrates how to get the size of an existing file on the server. Objective-C

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

BOOL success = NO;

//  This example assumes the Chilkat API to have been previously unlocked.
//  See Global Unlock Sample for sample code.

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

//  Set some timeouts, in milliseconds:
sftp.ConnectTimeoutMs = [NSNumber numberWithInt:5000];
sftp.IdleTimeoutMs = [NSNumber numberWithInt:10000];

//  Connect to the SSH server.  
//  The standard SSH port = 22
//  The hostname may be a hostname or IP address.
NSString *hostname = @"sftp.example.com";
int port = 22;
success = [sftp Connect: hostname port: [NSNumber numberWithInt: port]];
if (success != YES) {
    NSLog(@"%@",sftp.LastErrorText);
    return;
}

//  Authenticate with the SSH server.  Chilkat SFTP supports
//  both password-based authenication as well as public-key
//  authentication.  This example uses password authenication.
success = [sftp AuthenticatePw: @"myLogin" password: @"myPassword"];
if (success != YES) {
    NSLog(@"%@",sftp.LastErrorText);
    return;
}

//  After authenticating, the SFTP subsystem must be initialized:
success = [sftp InitializeSftp];
if (success != YES) {
    NSLog(@"%@",sftp.LastErrorText);
    return;
}

//  Assuming we know the file size won't be too large, we get the size as a 32-bit integer.
//  For SFTP, the remote file path is always either a path relative to the HOME directory of the user account, or an absolute path on the server.
BOOL bFollowLinks = YES;
BOOL bIsHandle = NO;
int fileSize = [[sftp GetFileSize64: @"someDir/someFile.dat" bFollowLinks: bFollowLinks bIsHandle: bIsHandle] longLongValue];
if (fileSize < 0) {
    NSLog(@"%@",sftp.LastErrorText);
    return;
}

NSLog(@"%@%d",@"file size = ",fileSize);

//  If the file size might be too large for a 32-bit signed integer, then get the size as a decimal string.
//  You can convert the string to a 64-bit integer in your programming language.
NSString *fileSizeStr = [sftp GetFileSizeStr: @"someDir/someFile.dat" bFollowLinks: bFollowLinks bIsHandle: bIsHandle];
if (sftp.LastMethodSuccess == NO) {
    NSLog(@"%@",sftp.LastErrorText);
    return;
}

NSLog(@"%@%@",@"file size = ",fileSizeStr);

//  You can alternatively get the size with an open file handle.
NSString *handle = [sftp OpenFile: @"someDir/someFile.dat" access: @"readOnly" createDisp: @"openExisting"];
if (sftp.LastMethodSuccess != YES) {
    NSLog(@"%@",sftp.LastErrorText);
    return;
}

//  Get the size using the handle.
bIsHandle = YES;
fileSize = [[sftp GetFileSize64: @"someDir/someFile.dat" bFollowLinks: bFollowLinks bIsHandle: bIsHandle] longLongValue];
if (fileSize < 0) {
    NSLog(@"%@",sftp.LastErrorText);
    return;
}

NSLog(@"%@%d",@"file size = ",fileSize);

//  -----------------------------------------------------------------------------
//  Don't forget to close the file handle.
//  Otherwise open handles will accumulate on the server until eventually a limit
//  is reached and the server will fail on a call to OpenFile.
//  -----------------------------------------------------------------------------

//  Close the file.
success = [sftp CloseHandle: handle];
if (success != YES) {
    NSLog(@"%@",sftp.LastErrorText);
    return;
}