(JavaScript) SFTP Get Size of File on Server

See more SFTP Examples

Note

This example is intended for running within a Chilkat.Js embedded JavaScript engine. All Chilkat JavaScript examples require Chilkat v11.4.0 or greater.

var success = false;

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

var sftp = new CkSFtp();

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

// Connect to the SSH server.  
// The standard SSH port = 22
// The hostname may be a hostname or IP address.
var hostname = "sftp.example.com";
var port = 22;
success = sftp.Connect(hostname,port);
if (success !== true) {
    console.log(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","myPassword");
if (success !== true) {
    console.log(sftp.LastErrorText);
    return;
}

// After authenticating, the SFTP subsystem must be initialized:
success = sftp.InitializeSftp();
if (success !== true) {
    console.log(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.
var bFollowLinks = true;
var bIsHandle = false;
var fileSize = sftp.GetFileSize32("someDir/someFile.dat",bFollowLinks,bIsHandle);
if (fileSize < 0) {
    console.log(sftp.LastErrorText);
    return;
}

console.log("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.
var fileSizeStr = sftp.GetFileSizeStr("someDir/someFile.dat",bFollowLinks,bIsHandle);
if (sftp.LastMethodSuccess == false) {
    console.log(sftp.LastErrorText);
    return;
}

console.log("file size = " + fileSizeStr);

// You can alternatively get the size with an open file handle.
var handle = sftp.OpenFile("someDir/someFile.dat","readOnly","openExisting");
if (sftp.LastMethodSuccess !== true) {
    console.log(sftp.LastErrorText);
    return;
}

// Get the size using the handle.
bIsHandle = true;
fileSize = sftp.GetFileSize32("someDir/someFile.dat",bFollowLinks,bIsHandle);
if (fileSize < 0) {
    console.log(sftp.LastErrorText);
    return;
}

console.log("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 !== true) {
    console.log(sftp.LastErrorText);
    return;
}