PureBasic

Set FTP Command and Directory-Listing Charsets

Demonstrates the CommandCharset and DirListingCharset properties, which control how non-ASCII text is encoded in commands (including remote paths and filenames) and how directory-listing responses are decoded.

Background: FTP predates Unicode, so servers vary in how they encode filenames; getting non-ASCII names right means matching the server's encoding on both sides. CommandCharset (default ANSI) governs outgoing paths and filenames, while DirListingCharset governs decoding of LIST/NLST/MLSD replies. Modern servers typically use UTF-8 — often negotiated automatically via OPTS UTF8 ON — but setting these explicitly resolves mojibake with servers that do not advertise it.

Chilkat PureBasic Downloads

Download Chilkat for PureBasic

PureBasic

IncludeFile "CkFtp2.pb"

Procedure ChilkatExample()

    success.i = 0

    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")

    ;  CommandCharset is the encoding used for commands containing non-ASCII text, including remote
    ;  paths and filenames.  The default is ANSI; set utf-8 when the server uses UTF-8 filenames.
    CkFtp2::setCkCommandCharset(ftp, "utf-8")

    ;  DirListingCharset is used only to decode directory-listing responses (LIST, NLST, MLSD).  It
    ;  does not affect commands or paths.
    CkFtp2::setCkDirListingCharset(ftp, "utf-8")

    ;  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

    ;  Non-ASCII remote paths and listings are now encoded/decoded as UTF-8.
    listing.s = CkFtp2::ckGetTextDirListing(ftp,"")
    If CkFtp2::ckLastMethodSuccess(ftp) = 0
        Debug CkFtp2::ckLastErrorText(ftp)
        CkFtp2::ckDispose(ftp)
        ProcedureReturn
    EndIf

    Debug listing

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



    CkFtp2::ckDispose(ftp)


    ProcedureReturn
EndProcedure