PureBasic

Get an FTP Listing Entry's Size (32-bit)

Demonstrates the Chilkat Ftp2.GetSize method, which returns the size in bytes of a cached directory-listing entry as a 32-bit integer. The only argument is a zero-based index. It returns -1 when the index is invalid or the size is unavailable.

Background: The size comes from the cached listing, so reading it for every entry costs no extra round trips. A 32-bit result cannot represent files past about 2 GB, so use GetSize64 (or GetSizeStr) when large files are possible. Directories often report no meaningful size and come back as -1, which is why the -1 case is worth handling rather than printing blindly.

Chilkat PureBasic Downloads

Download Chilkat for PureBasic

PureBasic

IncludeFile "CkFtp2.pb"

Procedure ChilkatExample()

    success.i = 0

    ;  Demonstrates the Ftp2.GetSize method, which returns the size in bytes of a cached
    ;  directory-listing entry as a 32-bit integer.  The only argument is a zero-based index.

    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

    ;  GetDirCount retrieves the directory listing on the first call and returns the number of
    ;  entries.  A negative return indicates failure.
    n.i = CkFtp2::ckGetDirCount(ftp)
    If n < 0
        Debug CkFtp2::ckLastErrorText(ftp)
        CkFtp2::ckDispose(ftp)
        ProcedureReturn
    EndIf

    i.i
    For i = 0 To n - 1
        name.s = CkFtp2::ckGetFilename(ftp,i)

        ;  GetSize returns -1 when the index is invalid or the size is unavailable (for example for a
        ;  directory).  Use GetSize64 for files that may exceed 2 GB.
        fileSize.i = CkFtp2::ckGetSize(ftp,i)
        Debug name + "  " + Str(fileSize) + " bytes"
    Next

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



    CkFtp2::ckDispose(ftp)


    ProcedureReturn
EndProcedure