DataFlex

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 DataFlex Downloads

Download Chilkat for DataFlex

DataFlex

Use ChilkatAx-win32.pkg

Procedure Test
    Boolean iSuccess
    Handle hoSftp
    Integer iPort
    String sPassword
    Boolean iBFollowLinks
    Boolean iBIsHandle
    Integer iFileSize
    String sTemp1

    Move False To iSuccess

    //  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.

    Get Create (RefClass(cComChilkatSFtp)) To hoSftp
    If (Not(IsComObjectCreated(hoSftp))) Begin
        Send CreateComObject of hoSftp
    End

    //  Connect, authenticate, and initialize the SFTP subsystem.
    Move 22 To iPort
    Get ComConnect Of hoSftp "sftp.example.com" iPort To iSuccess
    If (iSuccess = False) Begin
        Get ComLastErrorText Of hoSftp To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    //  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.
    Move "mySshPassword" To sPassword

    Get ComAuthenticatePw Of hoSftp "mySshLogin" sPassword To iSuccess
    If (iSuccess = False) Begin
        Get ComLastErrorText Of hoSftp To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    Get ComInitializeSftp Of hoSftp To iSuccess
    If (iSuccess = False) Begin
        Get ComLastErrorText Of hoSftp To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    //  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.
    Move True To iBFollowLinks
    Move False To iBIsHandle

    Get ComGetFileSize32 Of hoSftp "subdir/report.pdf" iBFollowLinks iBIsHandle To iFileSize
    If (iFileSize < 0) Begin
        Get ComLastErrorText Of hoSftp To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    Showln "File size: " iFileSize " bytes"

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

    Send ComDisconnect To hoSftp


End_Procedure