PureBasic

Get a Filename from an FTP Directory Listing

Demonstrates the Chilkat Ftp2.GetFilename method, which returns the name of a cached directory-listing entry. The only argument is a zero-based index from 0 through GetDirCount - 1.

Background: The Chilkat FTP directory API is index-based and works from a single cached listing: the first GetDirCount call fetches the current directory's listing once, and every indexed accessor — name, size, type, permissions, timestamps — then reads from that cache without further server round trips. That makes iterating a directory efficient, but it also means the data reflects the moment the listing was fetched; call ClearDirCache to force a refresh after the remote directory changes.

Chilkat PureBasic Downloads

Download Chilkat for PureBasic

PureBasic

IncludeFile "CkFtp2.pb"

Procedure ChilkatExample()

    success.i = 0

    ;  Demonstrates the Ftp2.GetFilename method, which returns the name of a cached directory-listing
    ;  entry.  The only argument is a zero-based index from 0 through GetDirCount - 1.

    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)
        Debug name
    Next

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



    CkFtp2::ckDispose(ftp)


    ProcedureReturn
EndProcedure