AutoIt

SFTP Get Size of File on Server

See more SFTP Examples

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

Local $bSuccess = False

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

$oSftp = ObjCreate("Chilkat.SFtp")

; Set some timeouts, in milliseconds:
$oSftp.ConnectTimeoutMs = 5000
$oSftp.IdleTimeoutMs = 10000

; Connect to the SSH server.  
; The standard SSH port = 22
; The hostname may be a hostname or IP address.
Local $sHostname = "sftp.example.com"
Local $iPort = 22
$bSuccess = $oSftp.Connect($sHostname,$iPort)
If ($bSuccess <> True) Then
    ConsoleWrite($oSftp.LastErrorText & @CRLF)
    Exit
EndIf

; Authenticate with the SSH server.  Chilkat SFTP supports
; both password-based authenication as well as public-key
; authentication.  This example uses password authenication.
$bSuccess = $oSftp.AuthenticatePw("myLogin","myPassword")
If ($bSuccess <> True) Then
    ConsoleWrite($oSftp.LastErrorText & @CRLF)
    Exit
EndIf

; After authenticating, the SFTP subsystem must be initialized:
$bSuccess = $oSftp.InitializeSftp()
If ($bSuccess <> True) Then
    ConsoleWrite($oSftp.LastErrorText & @CRLF)
    Exit
EndIf

; 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.
Local $bFollowLinks = True
Local $bIsHandle = False
Local $iFileSize = $oSftp.GetFileSize32("someDir/someFile.dat",$bFollowLinks,$bIsHandle)
If ($iFileSize < 0) Then
    ConsoleWrite($oSftp.LastErrorText & @CRLF)
    Exit
EndIf

ConsoleWrite("file size = " & $iFileSize & @CRLF)

; 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.
Local $sFileSizeStr = $oSftp.GetFileSizeStr("someDir/someFile.dat",$bFollowLinks,$bIsHandle)
If ($oSftp.LastMethodSuccess = False) Then
    ConsoleWrite($oSftp.LastErrorText & @CRLF)
    Exit
EndIf

ConsoleWrite("file size = " & $sFileSizeStr & @CRLF)

; You can alternatively get the size with an open file handle.
Local $sHandle = $oSftp.OpenFile("someDir/someFile.dat","readOnly","openExisting")
If ($oSftp.LastMethodSuccess <> True) Then
    ConsoleWrite($oSftp.LastErrorText & @CRLF)
    Exit
EndIf

; Get the size using the handle.
$bIsHandle = True
$iFileSize = $oSftp.GetFileSize32("someDir/someFile.dat",$bFollowLinks,$bIsHandle)
If ($iFileSize < 0) Then
    ConsoleWrite($oSftp.LastErrorText & @CRLF)
    Exit
EndIf

ConsoleWrite("file size = " & $iFileSize & @CRLF)

; -----------------------------------------------------------------------------
; 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.
$bSuccess = $oSftp.CloseHandle($sHandle)
If ($bSuccess <> True) Then
    ConsoleWrite($oSftp.LastErrorText & @CRLF)
    Exit
EndIf