SFTP Read Directory Listing

Demonstrates how to download a directory listing and iterate over the files.

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

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

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

CREATE PROCEDURE ChilkatSample
AS
BEGIN
    DECLARE @hr int
    DECLARE @iTmp0 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', 10000

    --  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 = 'www.my-sftp-server.com'
    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 directory on the server...
    --  Paths starting with a slash are "absolute", and are relative
    --  to the root of the file system. Names starting with any other
    --  character are relative to the user's default directory (home directory).
    --  A path component of ".." refers to the parent directory,
    --  and "." refers to the current directory.
    DECLARE @handle nvarchar(4000)

    EXEC sp_OAMethod @sftp, 'OpenDir', @handle OUT, '.'
    IF @handle Is NULL 
      BEGIN
        EXEC sp_OAGetProperty @sftp, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        RETURN
      END

    --  Download the directory listing:
    DECLARE @dirListing int

    EXEC sp_OAMethod @sftp, 'ReadDir', @dirListing OUT, @handle
    IF @dirListing Is NULL 
      BEGIN
        EXEC sp_OAGetProperty @sftp, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        RETURN
      END

    --  Iterate over the files.
    DECLARE @i int

    DECLARE @n int

    EXEC sp_OAGetProperty @dirListing, 'NumFilesAndDirs', @n OUT

    IF @n = 0
      BEGIN

        PRINT 'No entries found in this directory.'
      END
    ELSE
      BEGIN
        SELECT @i = 0
        WHILE @i <= @n - 1
          BEGIN
            DECLARE @fileObj int

            EXEC sp_OAMethod @dirListing, 'GetFileObject', @fileObj OUT, @i

            EXEC sp_OAGetProperty @fileObj, 'Filename', @sTmp0 OUT

            PRINT @sTmp0
            EXEC sp_OAGetProperty @fileObj, 'FileType', @sTmp0 OUT

            PRINT @sTmp0

            EXEC sp_OAGetProperty @fileObj, 'Size32', @iTmp0 OUT

            PRINT 'Size in bytes: ' + @iTmp0

            PRINT '----'

            SELECT @i = @i + 1
          END
      END

    --  Close the directory
    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