Xojo Plugin

Get a Remote File's Size as a String

Demonstrates the Chilkat SFtp.GetFileSizeStr method, which returns a remote file's size in bytes as a decimal string. The arguments are the remote path (or handle), whether symbolic links are followed, and whether the first argument is a handle.

Background: Returning the size as a string sidesteps integer-width limits entirely, so it is the safe choice for files of any size — multi-gigabyte archives, disk images, database dumps. It is also convenient in programming languages that lack a native 64-bit integer type. When you need to do arithmetic on the value, parse the string; when you only need to display or log it, the string is ready to use.

Chilkat Xojo Plugin Downloads

Download Chilkat for Xojo Plugin

Xojo Plugin

Dim success As Boolean
success = False

//  Demonstrates the SFtp.GetFileSizeStr method, which returns a remote file's size in bytes as a
//  decimal string.  The 1st argument is the remote path (or handle), the 2nd selects whether
//  symbolic links are followed, and the 3rd indicates whether the 1st argument is a handle.

Dim sftp As New Chilkat.SFtp

//  Connect, authenticate, and initialize the SFTP subsystem.
Dim port As Int32
port = 22
success = sftp.Connect("sftp.example.com",port)
If (success = False) Then
    System.DebugLog(sftp.LastErrorText)
    Return
End If

//  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.
Dim password As String
password = "mySshPassword"

success = sftp.AuthenticatePw("mySshLogin",password)
If (success = False) Then
    System.DebugLog(sftp.LastErrorText)
    Return
End If

success = sftp.InitializeSftp()
If (success = False) Then
    System.DebugLog(sftp.LastErrorText)
    Return
End If

//  The 2nd argument (bFollowLinks) selects whether a symbolic link is followed to its target.
//  The 3rd argument (bIsHandle) is 0 here because the 1st argument is a path, not an
//  open handle.
Dim bFollowLinks As Boolean
bFollowLinks = True
Dim bIsHandle As Boolean
bIsHandle = False

//  A string return avoids the 32-bit overflow that GetFileSize32 would have for very large files.
Dim fileSize As String
fileSize = sftp.GetFileSizeStr("subdir/hugefile.dat",bFollowLinks,bIsHandle)
If (sftp.LastMethodSuccess = False) Then
    System.DebugLog(sftp.LastErrorText)
    Return
End If

System.DebugLog("File size: " + fileSize + " bytes")

sftp.Disconnect