VB.NET

SFTP Get Size of File on Server

See more SFTP Examples

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

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


' After authenticating, the SFTP subsystem must be initialized:
success = sftp.InitializeSftp()
If (success <> True) Then
    Debug.WriteLine(sftp.LastErrorText)
    Exit Sub
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 = True
Dim bIsHandle As Boolean = False
Dim fileSize As Integer = sftp.GetFileSize32("someDir/someFile.dat",bFollowLinks,bIsHandle)
If (fileSize < 0) Then
    Debug.WriteLine(sftp.LastErrorText)
    Exit Sub
End If

Debug.WriteLine("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.
Dim fileSizeStr As String = sftp.GetFileSizeStr("someDir/someFile.dat",bFollowLinks,bIsHandle)
If (sftp.LastMethodSuccess = False) Then
    Debug.WriteLine(sftp.LastErrorText)
    Exit Sub
End If

Debug.WriteLine("file size = " & fileSizeStr)

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


' Get the size using the handle.
bIsHandle = True
fileSize = sftp.GetFileSize32("someDir/someFile.dat",bFollowLinks,bIsHandle)
If (fileSize < 0) Then
    Debug.WriteLine(sftp.LastErrorText)
    Exit Sub
End If

Debug.WriteLine("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) Then
    Debug.WriteLine(sftp.LastErrorText)
    Exit Sub
End If