Xojo Plugin

SFTP Get Size of File on Server

See more SFTP Examples

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

Dim success As Boolean
success = False

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

Dim sftp As New Chilkat.SFtp

// 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.
Dim hostname As String
hostname = "sftp.example.com"
Dim port As Int32
port = 22
success = sftp.Connect(hostname,port)
If (success <> True) Then
    System.DebugLog(sftp.LastErrorText)
    Return
End If

// 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) Then
    System.DebugLog(sftp.LastErrorText)
    Return
End If

// After authenticating, the SFTP subsystem must be initialized:
success = sftp.InitializeSftp()
If (success <> True) Then
    System.DebugLog(sftp.LastErrorText)
    Return
End If

// 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.
Dim bFollowLinks As Boolean
bFollowLinks = True
Dim bIsHandle As Boolean
bIsHandle = False
Dim fileSize As Int32
fileSize = sftp.GetFileSize32("someDir/someFile.dat",bFollowLinks,bIsHandle)
If (fileSize < 0) Then
    System.DebugLog(sftp.LastErrorText)
    Return
End If

System.DebugLog("file size = " + Str(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.
Dim fileSizeStr As String
fileSizeStr = sftp.GetFileSizeStr("someDir/someFile.dat",bFollowLinks,bIsHandle)
If (sftp.LastMethodSuccess = False) Then
    System.DebugLog(sftp.LastErrorText)
    Return
End If

System.DebugLog("file size = " + fileSizeStr)

// You can alternatively get the size with an open file handle.
Dim handle As String
handle = sftp.OpenFile("someDir/someFile.dat","readOnly","openExisting")
If (sftp.LastMethodSuccess <> True) Then
    System.DebugLog(sftp.LastErrorText)
    Return
End If

// Get the size using the handle.
bIsHandle = True
fileSize = sftp.GetFileSize32("someDir/someFile.dat",bFollowLinks,bIsHandle)
If (fileSize < 0) Then
    System.DebugLog(sftp.LastErrorText)
    Return
End If

System.DebugLog("file size = " + Str(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) Then
    System.DebugLog(sftp.LastErrorText)
    Return
End If