SFTP Writing utf-8 vs. ANSI Text Files

Demonstrates how to specify the charset, such as utf-8, ANSI, windows-1250, iso-8859-1, Shift_JIS, etc., when writing text files. See the List of Charsets for all supported charsets.

Download Chilkat 32-bit SSH / SFTP ActiveX (.msi)

Download All 32-bit Chilkat ActiveX Components (.zip)

Download All 64-bit Chilkat ActiveX Components (.zip)

LOCAL loSftp
LOCAL lnSuccess
LOCAL lnPort
LOCAL lcHostname
LOCAL lcHandle

*  Important: It is helpful to send the contents of the
*  sftp.LastErrorText property when requesting support.

loSftp = CreateObject('Chilkat.SFtp')

*  Any string automatically begins a fully-functional 30-day trial.

lnSuccess = loSftp.UnlockComponent("Anything for 30-day trial")
IF (lnSuccess <> 1) THEN
    =MESSAGEBOX(loSftp.LastErrorText)
    QUIT
ENDIF

*  Set some timeouts, in milliseconds:
loSftp.ConnectTimeoutMs = 5000
loSftp.IdleTimeoutMs = 15000

*  Connect to the SSH server.
*  The standard SSH port = 22
*  The hostname may be a hostname or IP address.

lcHostname = "192.168.1.108"
lnPort = 22
lnSuccess = loSftp.Connect(lcHostname,lnPort)
IF (lnSuccess <> 1) THEN
    =MESSAGEBOX(loSftp.LastErrorText)
    QUIT
ENDIF

*  Authenticate with the SSH server.  Chilkat SFTP supports
*  both password-based authenication as well as public-key
*  authentication.  This example uses password authenication.
lnSuccess = loSftp.AuthenticatePw("myLogin","myPassword")
IF (lnSuccess <> 1) THEN
    =MESSAGEBOX(loSftp.LastErrorText)
    QUIT
ENDIF

*  After authenticating, the SFTP subsystem must be initialized:
lnSuccess = loSftp.InitializeSftp()
IF (lnSuccess <> 1) THEN
    =MESSAGEBOX(loSftp.LastErrorText)
    QUIT
ENDIF

*  Open a file on the server for writing.
*  "createTruncate" means that a new file is created; if the file already exists, it is opened and truncated.

lcHandle = loSftp.OpenFile("utf8_sample.txt","writeOnly","createTruncate")
IF (lcHandle = NULL ) THEN
    =MESSAGEBOX(loSftp.LastErrorText)
    QUIT
ENDIF

*  Write a single utf-8 character to the file - a lowercase ü
*  A "ü" in utf-8 is represented by 2 bytes:  0xC3 0xBC
*  The following call to WriteFileText writes 2 bytes (0xC3 0xBC)
*  to the file:
lnSuccess = loSftp.WriteFileText(lcHandle,"utf-8","ü")
IF (lnSuccess <> 1) THEN
    =MESSAGEBOX(loSftp.LastErrorText)
    QUIT
ENDIF

*  Close the file.
lnSuccess = loSftp.CloseHandle(lcHandle)
IF (lnSuccess <> 1) THEN
    =MESSAGEBOX(loSftp.LastErrorText)
    QUIT
ENDIF

*  Let's write the same "ü" character using windows-1252
*  (which is the ANSI charset for Western-European languages)
lcHandle = loSftp.OpenFile("windows1252_sample.txt","writeOnly","createTruncate")
IF (lcHandle = NULL ) THEN
    =MESSAGEBOX(loSftp.LastErrorText)
    QUIT
ENDIF

*  Write a single windows-1252 character to the file - a lowercase ü
*  A "ü" in windows-1252 is represented by 1 byte:  0xFC
*  The following call to WriteFileText writes 1 byte (0xFC)
*  to the file:
lnSuccess = loSftp.WriteFileText(lcHandle,"windows-1252","ü")
IF (lnSuccess <> 1) THEN
    =MESSAGEBOX(loSftp.LastErrorText)
    QUIT
ENDIF

*  Close the file.
lnSuccess = loSftp.CloseHandle(lcHandle)
IF (lnSuccess <> 1) THEN
    =MESSAGEBOX(loSftp.LastErrorText)
    QUIT
ENDIF

=MESSAGEBOX("Success.")