Get a Remote File's Size as a String

See more SFTP Examples

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.

Dim success As Boolean = 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 Integer = 22
success = sftp.Connect("sftp.example.com",port)
If (success = False) Then
    Debug.WriteLine(sftp.LastErrorText)
    Exit Sub
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 = "mySshPassword"

success = sftp.AuthenticatePw("mySshLogin",password)
If (success = False) Then
    Debug.WriteLine(sftp.LastErrorText)
    Exit Sub
End If


success = sftp.InitializeSftp()
If (success = False) Then
    Debug.WriteLine(sftp.LastErrorText)
    Exit Sub
End If


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

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

Debug.WriteLine("File size: " & fileSize & " bytes")

sftp.Disconnect()