Perl

SFTP Get Size of File on Server

See more SFTP Examples

Demonstrates how to get the size of an existing file on the server. Perl

use chilkat();

$success = 0;

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

$sftp = chilkat::CkSFtp->new();

# Set some timeouts, in milliseconds:
$sftp->put_ConnectTimeoutMs(5000);
$sftp->put_IdleTimeoutMs(10000);

# Connect to the SSH server.  
# The standard SSH port = 22
# The hostname may be a hostname or IP address.
$hostname = "sftp.example.com";
$port = 22;
$success = $sftp->Connect($hostname,$port);
if ($success != 1) {
    print $sftp->lastErrorText() . "\r\n";
    exit;
}

# 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","myPassword");
if ($success != 1) {
    print $sftp->lastErrorText() . "\r\n";
    exit;
}

# After authenticating, the SFTP subsystem must be initialized:
$success = $sftp->InitializeSftp();
if ($success != 1) {
    print $sftp->lastErrorText() . "\r\n";
    exit;
}

# 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.
$bFollowLinks = 1;
$bIsHandle = 0;
$fileSize = $sftp->GetFileSize32("someDir/someFile.dat",$bFollowLinks,$bIsHandle);
if ($fileSize < 0) {
    print $sftp->lastErrorText() . "\r\n";
    exit;
}

print "file size = " . $fileSize . "\r\n";

# 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.
$fileSizeStr = $sftp->getFileSizeStr("someDir/someFile.dat",$bFollowLinks,$bIsHandle);
if ($sftp->get_LastMethodSuccess() == 0) {
    print $sftp->lastErrorText() . "\r\n";
    exit;
}

print "file size = " . $fileSizeStr . "\r\n";

# You can alternatively get the size with an open file handle.
$handle = $sftp->openFile("someDir/someFile.dat","readOnly","openExisting");
if ($sftp->get_LastMethodSuccess() != 1) {
    print $sftp->lastErrorText() . "\r\n";
    exit;
}

# Get the size using the handle.
$bIsHandle = 1;
$fileSize = $sftp->GetFileSize32("someDir/someFile.dat",$bFollowLinks,$bIsHandle);
if ($fileSize < 0) {
    print $sftp->lastErrorText() . "\r\n";
    exit;
}

print "file size = " . $fileSize . "\r\n";

# -----------------------------------------------------------------------------
# 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 != 1) {
    print $sftp->lastErrorText() . "\r\n";
    exit;
}