PureBasic

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

Download Chilkat for PureBasic

PureBasic

IncludeFile "CkSFtp.pb"

Procedure ChilkatExample()

    success.i = 0

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

    sftp.i = CkSFtp::ckCreate()
    If sftp.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    ;  Connect, authenticate, and initialize the SFTP subsystem.
    port.i = 22
    success = CkSFtp::ckConnect(sftp,"sftp.example.com",port)
    If success = 0
        Debug CkSFtp::ckLastErrorText(sftp)
        CkSFtp::ckDispose(sftp)
        ProcedureReturn
    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.
    password.s = "mySshPassword"

    success = CkSFtp::ckAuthenticatePw(sftp,"mySshLogin",password)
    If success = 0
        Debug CkSFtp::ckLastErrorText(sftp)
        CkSFtp::ckDispose(sftp)
        ProcedureReturn
    EndIf

    success = CkSFtp::ckInitializeSftp(sftp)
    If success = 0
        Debug CkSFtp::ckLastErrorText(sftp)
        CkSFtp::ckDispose(sftp)
        ProcedureReturn
    EndIf

    ;  The 2nd argument (bFollowLinks) selects whether a symbolic link is followed to its target.
    ;  The 3rd argument (bIsHandle) is 0 here because the 1st argument is a path, not an
    ;  open handle.
    bFollowLinks.i = 1
    bIsHandle.i = 0

    fileSize.i = CkSFtp::ckGetFileSize32(sftp,"subdir/report.pdf",bFollowLinks,bIsHandle)
    If fileSize < 0
        Debug CkSFtp::ckLastErrorText(sftp)
        CkSFtp::ckDispose(sftp)
        ProcedureReturn
    EndIf

    Debug "File size: " + Str(fileSize) + " 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.

    CkSFtp::ckDisconnect(sftp)


    CkSFtp::ckDispose(sftp)


    ProcedureReturn
EndProcedure