AutoIt

Get a Remote File's Size (32-bit)

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

Background: A 32-bit signed integer tops out near 2 GB, so this is fine for ordinary files but will misreport or fail for larger ones. When a file might exceed that, use GetFileSizeStr, which returns the size as a decimal string and cannot overflow. The two boolean arguments are shared by all the attribute getters: the first follows symbolic links to their target, and the second says whether you passed a path or an open handle.

Chilkat AutoIt Downloads

Download Chilkat for AutoIt

AutoIt

Local $bSuccess = False

;  Demonstrates the SFtp.GetFileSize32 method, which returns a remote file's size in bytes as a
;  32-bit integer.  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.

$oSftp = ObjCreate("Chilkat.SFtp")

;  Connect, authenticate, and initialize the SFTP subsystem.
Local $iPort = 22
$bSuccess = $oSftp.Connect("sftp.example.com",$iPort)
If ($bSuccess = False) Then
    ConsoleWrite($oSftp.LastErrorText & @CRLF)
    Exit
EndIf

;  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.
Local $sPassword = "mySshPassword"

$bSuccess = $oSftp.AuthenticatePw("mySshLogin",$sPassword)
If ($bSuccess = False) Then
    ConsoleWrite($oSftp.LastErrorText & @CRLF)
    Exit
EndIf

$bSuccess = $oSftp.InitializeSftp()
If ($bSuccess = False) Then
    ConsoleWrite($oSftp.LastErrorText & @CRLF)
    Exit
EndIf

;  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.
Local $bFollowLinks = True
Local $bIsHandle = False

Local $iFileSize = $oSftp.GetFileSize32("subdir/report.pdf",$bFollowLinks,$bIsHandle)
If ($iFileSize < 0) Then
    ConsoleWrite($oSftp.LastErrorText & @CRLF)
    Exit
EndIf

ConsoleWrite("File size: " & $iFileSize & " bytes" & @CRLF)

;  Note: For files that may exceed 2 GB, use GetFileSizeStr (returns a decimal string) instead,
;  because the value can overflow a 32-bit integer.

$oSftp.Disconnect