PureBasic

Get a Remote FTP File's Size by Name

Demonstrates the Chilkat Ftp2.GetSizeByName method, which returns the size in bytes of a named file in the current remote directory as a 32-bit integer. The only argument is the filename — a name, not a path. It returns -1 when the file is not found or the size cannot be obtained.

Background: This is the direct way to get one file's size when you already know its name, typically via a SIZE command — no full directory listing required. Because the result is 32-bit, it cannot represent files past about 2 GB; use GetSizeStrByName for large files. The argument must be a bare filename in the current directory, so ChangeRemoteDir to the right place first.

Chilkat PureBasic Downloads

Download Chilkat for PureBasic

PureBasic

IncludeFile "CkFtp2.pb"

Procedure ChilkatExample()

    success.i = 0

    ;  Demonstrates the Ftp2.GetSizeByName method, which returns the size in bytes of a named file in
    ;  the current remote directory as a 32-bit integer.  The only argument is the filename (a name,
    ;  not a path).

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

    CkFtp2::setCkHostname(ftp, "ftp.example.com")
    CkFtp2::setCkUsername(ftp, "myFtpLogin")

    ;  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.
    CkFtp2::setCkPassword(ftp, "myPassword")

    success = CkFtp2::ckConnect(ftp)
    If success = 0
        Debug CkFtp2::ckLastErrorText(ftp)
        CkFtp2::ckDispose(ftp)
        ProcedureReturn
    EndIf

    success = CkFtp2::ckChangeRemoteDir(ftp,"public_html")
    If success = 0
        Debug CkFtp2::ckLastErrorText(ftp)
        CkFtp2::ckDispose(ftp)
        ProcedureReturn
    EndIf

    ;  Returns -1 when the file is not found or the size cannot be obtained.  For files that may
    ;  exceed 2 GB, use GetSizeStrByName (returns a decimal string).
    fileSize.i = CkFtp2::ckGetSizeByName(ftp,"report.pdf")
    If fileSize < 0
        Debug "File not found, or size unavailable."
        CkFtp2::ckDispose(ftp)
        ProcedureReturn
    EndIf

    Debug "report.pdf is " + Str(fileSize) + " bytes"

    success = CkFtp2::ckDisconnect(ftp)
    If success = 0
        Debug CkFtp2::ckLastErrorText(ftp)
        CkFtp2::ckDispose(ftp)
        ProcedureReturn
    EndIf



    CkFtp2::ckDispose(ftp)


    ProcedureReturn
EndProcedure