Tcl

SFTP Get Size of File on Server

See more SFTP Examples

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

load ./chilkat.dll

set success 0

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

set sftp [new_CkSFtp]

# Set some timeouts, in milliseconds:
CkSFtp_put_ConnectTimeoutMs $sftp 5000
CkSFtp_put_IdleTimeoutMs $sftp 10000

# Connect to the SSH server.  
# The standard SSH port = 22
# The hostname may be a hostname or IP address.
set hostname "sftp.example.com"
set port 22
set success [CkSFtp_Connect $sftp $hostname $port]
if {$success != 1} then {
    puts [CkSFtp_lastErrorText $sftp]
    delete_CkSFtp $sftp
    exit
}

# Authenticate with the SSH server.  Chilkat SFTP supports
# both password-based authenication as well as public-key
# authentication.  This example uses password authenication.
set success [CkSFtp_AuthenticatePw $sftp "myLogin" "myPassword"]
if {$success != 1} then {
    puts [CkSFtp_lastErrorText $sftp]
    delete_CkSFtp $sftp
    exit
}

# After authenticating, the SFTP subsystem must be initialized:
set success [CkSFtp_InitializeSftp $sftp]
if {$success != 1} then {
    puts [CkSFtp_lastErrorText $sftp]
    delete_CkSFtp $sftp
    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.
set bFollowLinks 1
set bIsHandle 0
set fileSize [CkSFtp_GetFileSize32 $sftp "someDir/someFile.dat" $bFollowLinks $bIsHandle]
if {$fileSize < 0} then {
    puts [CkSFtp_lastErrorText $sftp]
    delete_CkSFtp $sftp
    exit
}

puts "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.
set fileSizeStr [CkSFtp_getFileSizeStr $sftp "someDir/someFile.dat" $bFollowLinks $bIsHandle]
if {[CkSFtp_get_LastMethodSuccess $sftp] == 0} then {
    puts [CkSFtp_lastErrorText $sftp]
    delete_CkSFtp $sftp
    exit
}

puts "file size = $fileSizeStr"

# You can alternatively get the size with an open file handle.
set handle [CkSFtp_openFile $sftp "someDir/someFile.dat" "readOnly" "openExisting"]
if {[CkSFtp_get_LastMethodSuccess $sftp] != 1} then {
    puts [CkSFtp_lastErrorText $sftp]
    delete_CkSFtp $sftp
    exit
}

# Get the size using the handle.
set bIsHandle 1
set fileSize [CkSFtp_GetFileSize32 $sftp "someDir/someFile.dat" $bFollowLinks $bIsHandle]
if {$fileSize < 0} then {
    puts [CkSFtp_lastErrorText $sftp]
    delete_CkSFtp $sftp
    exit
}

puts "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.
set success [CkSFtp_CloseHandle $sftp $handle]
if {$success != 1} then {
    puts [CkSFtp_lastErrorText $sftp]
    delete_CkSFtp $sftp
    exit
}


delete_CkSFtp $sftp