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 SSH / SFTP ActiveX

CREATE PROCEDURE ChilkatSample
AS
BEGIN
    DECLARE @hr int
    DECLARE @sTmp0 nvarchar(4000)
    --  Important: It is helpful to send the contents of the
    --  sftp.LastErrorText property when requesting support.

    DECLARE @sftp int
    EXEC @hr = sp_OACreate 'Chilkat.SFtp', @sftp OUT
    IF @hr <> 0
    BEGIN
        PRINT 'Failed to create ActiveX component'
        RETURN
    END

    --  Any string automatically begins a fully-functional 30-day trial.
    DECLARE @success int

    EXEC sp_OAMethod @sftp, 'UnlockComponent', @success OUT, 'Anything for 30-day trial'
    IF @success <> 1
      BEGIN
        EXEC sp_OAGetProperty @sftp, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        RETURN
      END

    --  Set some timeouts, in milliseconds:
    EXEC sp_OASetProperty @sftp, 'ConnectTimeoutMs', 5000
    EXEC sp_OASetProperty @sftp, 'IdleTimeoutMs', 15000

    --  Connect to the SSH server.
    --  The standard SSH port = 22
    --  The hostname may be a hostname or IP address.
    DECLARE @port int

    DECLARE @hostname nvarchar(4000)

    SELECT @hostname = '192.168.1.108'
    SELECT @port = 22
    EXEC sp_OAMethod @sftp, 'Connect', @success OUT, @hostname, @port
    IF @success <> 1
      BEGIN
        EXEC sp_OAGetProperty @sftp, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        RETURN
      END

    --  Authenticate with the SSH server.  Chilkat SFTP supports
    --  both password-based authenication as well as public-key
    --  authentication.  This example uses password authenication.
    EXEC sp_OAMethod @sftp, 'AuthenticatePw', @success OUT, 'myLogin', 'myPassword'
    IF @success <> 1
      BEGIN
        EXEC sp_OAGetProperty @sftp, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        RETURN
      END

    --  After authenticating, the SFTP subsystem must be initialized:
    EXEC sp_OAMethod @sftp, 'InitializeSftp', @success OUT
    IF @success <> 1
      BEGIN
        EXEC sp_OAGetProperty @sftp, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        RETURN
      END

    --  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.
    DECLARE @handle nvarchar(4000)

    EXEC sp_OAMethod @sftp, 'OpenFile', @handle OUT, 'utf8_sample.txt', 'writeOnly', 'createTruncate'
    IF @handle Is NULL 
      BEGIN
        EXEC sp_OAGetProperty @sftp, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        RETURN
      END

    --  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:
    EXEC sp_OAMethod @sftp, 'WriteFileText', @success OUT, @handle, 'utf-8', 'ü'
    IF @success <> 1
      BEGIN
        EXEC sp_OAGetProperty @sftp, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        RETURN
      END

    --  Close the file.
    EXEC sp_OAMethod @sftp, 'CloseHandle', @success OUT, @handle
    IF @success <> 1
      BEGIN
        EXEC sp_OAGetProperty @sftp, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        RETURN
      END

    --  Let's write the same "ü" character using windows-1252
    --  (which is the ANSI charset for Western-European languages)
    EXEC sp_OAMethod @sftp, 'OpenFile', @handle OUT, 'windows1252_sample.txt', 'writeOnly', 'createTruncate'
    IF @handle Is NULL 
      BEGIN
        EXEC sp_OAGetProperty @sftp, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        RETURN
      END

    --  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:
    EXEC sp_OAMethod @sftp, 'WriteFileText', @success OUT, @handle, 'windows-1252', 'ü'
    IF @success <> 1
      BEGIN
        EXEC sp_OAGetProperty @sftp, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        RETURN
      END

    --  Close the file.
    EXEC sp_OAMethod @sftp, 'CloseHandle', @success OUT, @handle
    IF @success <> 1
      BEGIN
        EXEC sp_OAGetProperty @sftp, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        RETURN
      END

    PRINT 'Success.'
END
GO