SFtp VB.NET WinRT Reference Documentation

SFtp

SFTP implementation for file transfer and remote file management over SSH.

Object Creation

Dim obj As New Chilkat.SFtp()

Properties

AbortCurrent As Boolean

Introduced in version 9.5.0.58

When set to True, causes the currently running method to abort. Methods that always finish quickly (i.e.have no length file operations or network communications) are not affected. If no method is running, then this property is automatically reset to False when the next method is called. When the abort occurs, this property is reset to False. Both synchronous and asynchronous method calls can be aborted. (A synchronous method call could be aborted by setting this property from a separate thread.)

AccumulateBuffer As Byte() (ReadOnly)

Contains the bytes downloaded from a remote file via the AccumulateBytes method call. Each call to AccumulateBytes appends to this buffer. To clear this buffer, call the ClearAccumulateBuffer method.

AuthFailReason As Integer (ReadOnly)

Introduced in version 9.5.0.52

Set to one of the following values if a call to AuthenticatePw, AuthenticatePk, or AuthenticatePwPk returns a failed status.

  • 1: Transport failure. This is a failure to communicate with the server (i.e. the connection was lost, or a read or write failed or timed out).
  • 2: Invalid key for public key authentication. The key was not a valid format, not a valid key, not a private key, or not the right type of key.
  • 3: No matching authentication methods were available.
  • 4: SSH authentication protocol error - an unexpected or invalid message was received.
  • 5: The incorrect password or private key was provided.
  • 6: Already authenticated. The SSH session is already authenticated.
  • 7: Password change request: The server requires the password to be changed.

BandwidthThrottleDown As Integer

Introduced in version 9.5.0.49

If non-zero, limits (throttles) the download bandwidth to approximately this maximum number of bytes per second. The default value of this property is 0.

BandwidthThrottleUp As Integer

Introduced in version 9.5.0.49

If non-zero, limits (throttles) the upload bandwidth to approximately this maximum number of bytes per second. The default value of this property is 0.

SFTP Upload with Bandwidth Throttling

ClientIdentifier As String

The client-identifier string to be used when connecting to an SSH/SFTP server. Defaults to "SSH-2.0-PuTTY_Release_0.63". (This string is used to mimic PuTTY because some servers are known to disconnect from clients with unknown client identifiers.)

ClientIpAddress As String

The IP address to use for computers with multiple network interfaces or IP addresses. For computers with a single network interface (i.e. most computers), this property should not be set. For multihoming computers, the default IP address is automatically used if this property is not set.

The IP address is a string such as in dotted notation using numbers, not domain names, such as "165.164.55.124".

ConnectTimeoutMs As Integer

Maximum number of milliseconds to wait when connecting to an SSH server.

DebugLogFilePath As String

If set to a file path, causes each Chilkat method or property call to automatically append it's LastErrorText to the specified log file. The information is appended such that if a hang or crash occurs, it is possible to see the context in which the problem occurred, as well as a history of all Chilkat calls up to the point of the problem. The VerboseLogging property can be set to provide more detailed information.

This property is typically used for debugging the rare cases where a Chilkat method call hangs or generates an exception that halts program execution (i.e. crashes). A hang or crash should generally never happen. The typical causes of a hang are:

  1. a timeout related property was set to 0 to explicitly indicate that an infinite timeout is desired,
  2. the hang is actually a hang within an event callback (i.e. it is a hang within the application code), or
  3. there is an internal problem (bug) in the Chilkat code that causes the hang.

DisconnectCode As Integer (ReadOnly)

If the SSH/SFTP server sent a DISCONNECT message when closing the connection, this property contains the "reason code" as specified in RFC 4253:

           Symbolic name                                reason code
           -------------                                -----------
      SSH_DISCONNECT_HOST_NOT_ALLOWED_TO_CONNECT             1
      SSH_DISCONNECT_PROTOCOL_ERROR                          2
      SSH_DISCONNECT_KEY_EXCHANGE_FAILED                     3
      SSH_DISCONNECT_RESERVED                                4
      SSH_DISCONNECT_MAC_ERROR                               5
      SSH_DISCONNECT_COMPRESSION_ERROR                       6
      SSH_DISCONNECT_SERVICE_NOT_AVAILABLE                   7
      SSH_DISCONNECT_PROTOCOL_VERSION_NOT_SUPPORTED          8
      SSH_DISCONNECT_HOST_KEY_NOT_VERIFIABLE                 9
      SSH_DISCONNECT_CONNECTION_LOST                        10
      SSH_DISCONNECT_BY_APPLICATION                         11
      SSH_DISCONNECT_TOO_MANY_CONNECTIONS                   12
      SSH_DISCONNECT_AUTH_CANCELLED_BY_USER                 13
      SSH_DISCONNECT_NO_MORE_AUTH_METHODS_AVAILABLE         14
      SSH_DISCONNECT_ILLEGAL_USER_NAME                      15

DisconnectReason As String (ReadOnly)

If the SSH/SFTP server sent a DISCONNECT message when closing the connection, this property contains a descriptive string for the "reason code" as specified in RFC 4253.

EnableCache As Boolean

Controls whether the component keeps an internal file size & attribute cache. The cache affects the following methods: GetFileSize32, GetFileSize64, GetFileSizeStr, GetFileCreateTime, GetFileLastAccess, GetFileLastModified, GetFileOwner, GetFileGroup, and GetFilePermissions.

The file attribute cache exists to minimize communications with the SFTP server. If the cache is enabled, then a request for any single attribute will cause all of the attributes to be cached. A subsequent request for a different attribute of the same file will be fulfilled from cache, eliminating the need for a message to be sent to the SFTP server.

Note: Caching only occurs when filenames are used, not handles.

EnableCompression As Boolean

Introduced in version 9.5.0.56

Enables or disables the use of compression w/ the SSH connection. The default value is True, meaning that compression is used if the server supports it.

Some older SSH servers have been found that claim to support compression, but actually fail when compression is used. PuTTY does not enable compression by default. If trouble is encountered where the SSH server disconnects immediately after the connection is seemingly established (i.e. during authentication), then check to see if disabling compression resolves the problem.

FilenameCharset As String

Automatically set during the InitializeSftp method if the server sends a filename-charset name-value extension. Otherwise, may be set directly to the name of a charset, such as "utf-8", "iso-8859-1", "windows-1252", etc. ("ansi" is also a valid choice.) Incoming filenames are interpreted as utf-8 if no FilenameCharset is set. Outgoing filenames are sent using utf-8 by default. Otherwise, incoming and outgoing filenames use the charset specified by this property.

ForceCipher As String

Set to one of the following encryption algorithms to force that cipher to be used. By default, the component will automatically choose the first cipher supported by the server in the order listed here: "aes256-ctr", "aes128-ctr", "aes256-cbc", "aes128-cbc", "twofish256-cbc", "twofish128-cbc", "blowfish-cbc", "3des-cbc", "arcfour128", "arcfour256". (If blowfish is chosen, the encryption strength is 128 bits.)

Important: If this is property is set and the server does NOT support then encryption algorithm, then the Connect will fail.

ForceV3 As Boolean

If set to True, forces the client to choose version 3 of the SFTP protocol, even if the server supports a higher version. The default value of this property is False.

HeartbeatMs As Integer

This is the number of milliseconds between each AbortCheck event callback. The AbortCheck callback allows an application to abort any SFTP operation prior to completion. If HeartbeatMs is 0 (the default), no AbortCheck event callbacks will fire.

HostKeyAlg As String

Indicates the preferred host key algorithm to be used in establishing the SSH secure connection. The default is "DSS". It may be changed to "RSA" if needed. Chilkat recommends not changing this unless a problem warrants the change.

HostKeyFingerprint As String (ReadOnly)

Set after connecting to an SSH/SFTP server. The format of the fingerprint looks like this: "ssh-rsa 1024 68:ff:d1:4e:6c:ff:d7:b0:d6:58:73:85:07:bc:2e:d5"

HttpProxyAuthMethod As String

If an HTTP proxy requiring authentication is to be used, set this property to the HTTP proxy authentication method name. Valid choices are "Basic" or "NTLM".

HttpProxyDomain As String

The NTLM authentication domain (optional) if NTLM authentication is used w/ the HTTP proxy.

HttpProxyHostname As String

If an HTTP proxy is to be used, set this property to the HTTP proxy hostname or IPv4 address (in dotted decimal notation).

HttpProxyPassword As String

If an HTTP proxy requiring authentication is to be used, set this property to the HTTP proxy password.

HttpProxyPort As Integer

If an HTTP proxy is to be used, set this property to the HTTP proxy port number. (Two commonly used HTTP proxy ports are 8080 and 3128.)

HttpProxyUsername As String

If an HTTP proxy requiring authentication is to be used, set this property to the HTTP proxy login name.

IdleTimeoutMs As Integer

Causes SFTP operations to fail when progress for sending or receiving data halts for more than this number of milliseconds. Setting IdleTimeoutMs = 0 allows the application to wait indefinitely. The default value of this property is 30000 (which equals 30 seconds).

IncludeDotDirs As Boolean

If True, then the ReadDir method will include the "." and ".." directories in its results. The default value of this property is False.

InitializeFailCode As Integer (ReadOnly)

The InitializeSftp method call opens a channel for the SFTP session. If the request to open a channel fails, this property contains a code that identifies the reason for failure. The reason codes are defined in RFC 4254 and are reproduced here:

             Symbolic name                           reason code
             -------------                           -----------
            SSH_OPEN_ADMINISTRATIVELY_PROHIBITED          1
            SSH_OPEN_CONNECT_FAILED                       2
            SSH_OPEN_UNKNOWN_CHANNEL_TYPE                 3
            SSH_OPEN_RESOURCE_SHORTAGE                    4

InitializeFailReason As String (ReadOnly)

The InitializeSftp method call opens a channel for the SFTP session. If the request to open a channel fails, this property contains a description of the reason for failure. (It contains descriptive text matching the InitializeFailCode property.)

IsConnected As Boolean (ReadOnly)

Returns True if connected to the SSH server. Note: This does not mean authentication has happened or InitializeSftp has already succeeded. It only means that the connection has been established by calling Connect.

KeepSessionLog As Boolean

Controls whether communications to/from the SFTP server are saved to the SessionLog property. The default value is False. If this property is set to True, the contents of the SessionLog property will continuously grow as SFTP activity transpires. The purpose of the KeepSessionLog / SessionLog properties is to help in debugging any future problems that may arise.

LastErrorHtml As String (ReadOnly)

Provides information in HTML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

LastErrorText As String (ReadOnly)

Provides information in plain-text format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

Concept of LastErrorText

LastErrorText Standard Information

LastErrorXml As String (ReadOnly)

Provides information in XML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

LastMethodSuccess As Boolean

Introduced in version 9.5.0.52

Indicate whether the last method call succeeded or failed. A value of True indicates success, a value of False indicates failure. This property is automatically set for method calls. It is not modified by property accesses. The property is automatically set to indicate success for the following types of method calls:

  • Any method that returns a string.
  • Any method returning a Chilkat object, binary bytes, or a date/time.
  • Any method returning a standard boolean status value where success = True and failure = False.
  • Any method returning an integer where failure is defined by a return value less than zero.

Note: Methods that do not fit the above requirements will always set this property equal to True. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

MaxPacketSize As Integer

The maximum packet length to be used in the underlying SSH transport protocol. The default value is 32768. (This should generally be left unchanged.)

PasswordChangeRequested As Boolean (ReadOnly)

Set by the AuthenticatePw and AuthenticatePwPk methods. If the authenticate method returns a failed status, and this property is set to True, then it indicates the server requested a password change. In this case, re-call the authenticate method, but provide both the old and new passwords in the following format, where vertical bar characters encapsulate the old and new passwords:

|oldPassword|newPassword|

PercentDoneScale As Integer

Introduced in version 9.5.0.49

This property is only valid in programming environment and languages that allow for event callbacks.

Sets the value to be defined as 100% complete for the purpose of PercentDone event callbacks. The defaut value of 100 means that at most 100 event PercentDone callbacks will occur in a method that (1) is event enabled and (2) is such that it is possible to measure progress as a percentage completed. This property may be set to larger numbers to get more fine-grained PercentDone callbacks. For example, setting this property equal to 1000 will provide callbacks with .1 percent granularity. For example, a value of 453 would indicate 45.3% competed. This property is clamped to a minimum value of 10, and a maximum value of 100000.

PreferIpv6 As Boolean

If True, then use IPv6 over IPv4 when both are supported for a particular domain. The default value of this property is False, which will choose IPv4 over IPv6.

PreserveDate As Boolean

If True, then the file last-modified and create date/time will be preserved for downloaded and uploaded files. The default value is False.

Note: Prior to version 9.5.0.40, this property only applied to downloads. Starting in v9.5.0.40, it also applies to the UploadFileByName method.

  • It does not apply to uploads or downloads where the remote file is opened to obtain a handle, the data is uploaded/downloaded, and then the handle is closed.
  • The last-mod date/times are always preserved ini the SyncTreeDownload and SyncTreeUpload methods.

ProtocolVersion As Integer (ReadOnly)

The negotiated SFTP protocol version, which should be a value between 3 and 6 inclusive. When the InitializeSftp method is called, the Chilkat SFTP client sends it's highest supported protocol version to the server, and the server sends it's SFTP protocol version in response. The negotiated protocol (i.e. the protocol version used for the session) is the lower of the two numbers. If the SFTP server's protocol version is lower than 6, some file date/attributes are not supported because they are not supported by the earlier protocol version. These exceptions are noted throughout the reference documentation.

ReadDirMustMatch As String

Introduced in version 9.5.0.53

Can contain a wildcarded list of file patterns separated by semicolons. For example, "*.xml; *.txt; *.csv". If set, the ReadDir method will only return files that match any one of these patterns.

ReadDirMustNotMatch As String

Introduced in version 9.5.0.53

Can contain a wildcarded list of file patterns separated by semicolons. For example, "*.xml; *.txt; *.csv". If set, the ReadDir method will only return files that do not match any of these patterns.

ServerIdentifier As String (ReadOnly)

Introduced in version 9.5.0.71

The server-identifier string received from the server during connection establishment. For example, a typical value would be similar to "SSH-2.0-OpenSSH_7.2p2 Ubuntu-4ubuntu2.2".

SessionLog As String (ReadOnly)

Contains a log of the messages sent to/from the SFTP server. To enable session logging, set the KeepSessionLog property = True. Note: This property is not a filename -- it is a string property that contains the session log data.

SocksHostname As String

The SOCKS4/SOCKS5 hostname or IPv4 address (in dotted decimal notation). This property is only used if the SocksVersion property is set to 4 or 5).

SocksPassword As String

The SOCKS5 password (if required). The SOCKS4 protocol does not include the use of a password, so this does not apply to SOCKS4.

SocksPort As Integer

The SOCKS4/SOCKS5 proxy port. The default value is 1080. This property only applies if a SOCKS proxy is used (if the SocksVersion property is set to 4 or 5).

SocksUsername As String

The SOCKS4/SOCKS5 proxy username. This property is only used if the SocksVersion property is set to 4 or 5).

SocksVersion As Integer

SocksVersion May be set to one of the following integer values:

0 - No SOCKS proxy is used. This is the default.
4 - Connect via a SOCKS4 proxy.
5 - Connect via a SOCKS5 proxy.

SoRcvBuf As Integer

Sets the receive buffer size socket option. Normally, this property should be left unchanged. The default value is 4194304.

This property can be increased if download performance seems slow. It is recommended to be a multiple of 4096.

More Information about TCP performance and Buffer Sizes

SoSndBuf As Integer

Sets the send buffer size socket option. Normally, this property should be left unchanged. The default value is 262144.

This property can be increased if upload performance seems slow. It is recommended to be a multiple of 4096. Testing with sizes such as 512K and 1MB is reasonable.

More Information about TCP performance and Buffer Sizes

SyncDirectives As String

Introduced in version 9.5.0.58

A property that can contain a list of comma-separated keywords to control certain aspects of an upload or download synchronization (for the SyncTreeUpload and SyncTreeDownload methods). At this time there is only one possible directive, but others may be added in the future.

Set this property to "UploadIgnoreLocalOpenFailures" to skip local files that cannot be opened. A common reason for this would be if another process on the system has the file open for exclusive access.

SyncedFiles As String

Introduced in version 9.5.0.51

The paths of the files uploaded or downloaded in the last call to SyncUploadTree or SyncDownloadTree. The paths are listed one per line. In both cases (for upload and download) each line contains the paths relative to the root synced directory.

SyncMustMatch As String

Can contain a wildcarded list of file patterns separated by semicolons. For example, "*.xml; *.txt; *.csv". If set, the SyncTreeUpload and SyncTreeDownload methods will only transfer files that match any one of these patterns. This property only applies to files. It does not apply to sub-directory names when recursively traversing a directory tree.

SyncMustNotMatch As String

Can contain a wildcarded list of file patterns separated by semicolons. For example, "*.xml; *.txt; *.csv". If set, the SyncTreeUpload and SyncTreeDownload methods will not transfer files that match any one of these patterns. This property only applies to files. It does not apply to sub-directory names when recursively traversing a directory tree.

TcpNoDelay As Boolean

This property controls the use of the internal TCP_NODELAY socket option (which disables the Nagle algorithm). The default value of this property is False. Setting this value to True disables the delay of sending successive small packets on the network.

UploadChunkSize As Integer

The chunk size to use when uploading files via the UploadFile or UploadFileByName methods. The default value is 32000. If an upload fails because "WSAECONNABORTED An established connection was aborted by the software in your host machine.", then try setting this property to a smaller value, such as 4096. A smaller value will result in slower transfer rates, but may help avoid this problem.

UtcMode As Boolean

If True, then date/times are returned as UTC times. If False (the default) then date/times are returned as local times.

VerboseLogging As Boolean

If set to True, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is False. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.

Version As String (ReadOnly)

Version of the component/library, such as "9.5.0.63"

XferByteCount As UInteger (ReadOnly)

Introduced in version 9.5.0.71

The current transfer byte count for an ongoing upload or download. Programs doing asynchronous uploads or downloads can read this property in real time during the upload. For SyncTreeUpload and SyncTreeDownload operations, this is the real-time cumulative number of bytes for all files uploaded or downloaded.

XferByteCount64 As Int64 (ReadOnly)

Introduced in version 9.5.0.71

The current transfer byte count for an ongoing upload or download. Programs doing asynchronous uploads or downloads can read this property in real time during the upload. For SyncTreeUpload and SyncTreeDownload operations, this is the real-time cumulative number of bytes for all files uploaded or downloaded.

Methods

<Awaitable> Function AccumulateBytesAsync(ByVal handle As String, ByVal maxBytes As Integer) As IAsyncOperation(Of Integer)

Downloads bytes from an open file and appends them to the AccumulateBuffer. The handle is a file handle returned by the OpenFile method. The maxBytes is the maximum number of bytes to read. If the end-of-file is reached prior to reading the number of requested bytes, then fewer bytes may be returned.

Returns the number of bytes downloaded and appended to AccumulateBuffer. Returns -1 on error.

Function Add64(ByVal n1 As String, ByVal n2 As String) As String

Convenience method for 64-bit addition. Allows for two 64-bit integers to be passed as decimal strings and returns the sum in a decimal sting.

Returns Nothing on failure

<Awaitable> Function AuthenticatePkAsync(ByVal username As String, ByVal privateKey As SshKey) As IAsyncOperation(Of Boolean)

Authenticates with the SSH server using public-key authentication. The corresponding public key must have been installed on the SSH server for the username. Authentication will succeed if the matching privateKey is provided.

Important: When reporting problems, please send the full contents of the LastErrorText property to support@chilkatsoft.com.

Returns True for success, False for failure.

Use PuTTY Key for SFTP Authentication

<Awaitable> Function AuthenticatePwAsync(ByVal login As String, ByVal password As String) As IAsyncOperation(Of Boolean)

Authenticates with the SSH server using a login and password.

An SFTP session always begins by first calling Connect to connect to the SSH server, then calling either AuthenticatePw or AuthenticatePk to login, and finally calling InitializeSftp.

Important: When reporting problems, please send the full contents of the LastErrorText property to support@chilkatsoft.com.

Note: To learn about how to handle password change requests, see the PasswordChangeRequested property (above).

Returns True for success, False for failure.

<Awaitable> Function AuthenticatePwPkAsync(ByVal username As String, ByVal password As String, ByVal privateKey As SshKey) As IAsyncOperation(Of Boolean)

Authentication for SSH servers that require both a password and private key. (Most SSH servers are configured to require one or the other, but not both.)

Important: When reporting problems, please send the full contents of the LastErrorText property to support@chilkatsoft.com.

Returns True for success, False for failure.

<Awaitable> Function AuthenticateSecPwAsync(ByVal login As SecureString, ByVal password As SecureString) As IAsyncOperation(Of Boolean)

Introduced in version 9.5.0.71

The same as AuthenticatePw, but the login and password are passed in secure string objects.

Returns True for success, False for failure.

SFTP Authenticate Secure

<Awaitable> Function AuthenticateSecPwPkAsync(ByVal username As SecureString, ByVal password As SecureString, ByVal privateKey As SshKey) As IAsyncOperation(Of Boolean)

Introduced in version 9.5.0.71

The same as AuthenticatePwPk, but the login and password are passed in secure string objects.

Returns True for success, False for failure.

Sub ClearAccumulateBuffer()

Clears the contents of the AccumulateBuffer property.

Sub ClearCache()

Clears the internal file attribute cache. (Please refer to the EnableCache property for more information about the file attribute cache.)

Sub ClearSessionLog()

Clears the contents of the SessionLog property.

<Awaitable> Function CloseHandleAsync(ByVal handle As String) As IAsyncOperation(Of Boolean)

Closes a file on the SSH/SFTP server. handle is a file handle returned from a previous call to OpenFile or OpenDir.

Returns True for success, False for failure.

<Awaitable> Function ConnectAsync(ByVal domainName As String, ByVal port As Integer) As IAsyncOperation(Of Boolean)

Connects to an SSH/SFTP server. The domainName may be a domain name or an IP address (example: 192.168.1.10). Both IPv4 and IPv6 addresses are supported. The port is typically 22, which is the standard port for SSH servers.

An SFTP session always begins by first calling Connect to connect to the SSH server, then calling either AuthenticatePw or AuthenticatePk to login, and finally calling InitializeSftp.

Important: When reporting problems, please send the full contents of the LastErrorText property to support@chilkatsoft.com.

Important: All TCP-based Internet communications, regardless of the protocol (such as HTTP, FTP, SSH, IMAP, POP3, SMTP, etc.), and regardless of SSL/TLS, begin with establishing a TCP connection to a remote host:port. External security-related infrastructure such as software firewalls (Windows Firewall), hardware firewalls, anti-virus, at either source or destination (or both) can block the connection. If the connection fails, make sure to check all potential external causes of blockage.

Returns True for success, False for failure.

<Awaitable> Function ConnectThroughSshAsync(ByVal sshConn As Ssh, ByVal hostname As String, ByVal port As Integer) As IAsyncOperation(Of Boolean)

Introduced in version 9.5.0.55

Connects to an SSH/SFTP server through an existing SSH connection. The sshConn is an existing connected and authenticated SSH object. The connection to hostname:port is made through the existing SSH connection via port-forwarding. If successful, the connection is as follows: application => ServerSSH1 => ServerSSH2. (where ServerSSH1 is the sshConn and ServerSSH2 is the SSH server at hostname:port) Once connected in this way, all communications are routed through ServerSSH1 to ServerSSH2. This includes authentication -- which means the application must still call one of the Authenticate* methods to authenticate with ServerSSH2.

Returns True for success, False for failure.

Multiple Hop SSH to SFTP

<Awaitable> Function CopyFileAttrAsync(ByVal localFilename As String, ByVal remoteFilename As String, ByVal isHandle As Boolean) As IAsyncOperation(Of Boolean)

Sets the date/time and other attributes of a remote file to be equal to that of a local file.

The attributes copied depend on the SFTP version of the server:

SFTP v3 (and below)
    Last-Modified Date/Time
    Last-Access Date/Time

SFTP v4, v5
    Last-Modified Date/Time
    Last-Access Date/Time
    Create Date/Time

SFTP v6 (and above)
    Last-Modified Date/Time
    Last-Access Date/Time
    Create Date/Time
    Read-Only Flag
    Hidden Flag
    Archive Flag
    Compressed Flag
    Encrypted Flag

Notes:
(1) The Last-Access date/time may or may not be set. Chilkat has found that the Last-Access time is set to the current date/time, which is probably a result of the operating system setting it based on when the SFTP server is touching the file.
(2) At the time of this writing, it is unknown whether the compressed/encryption settings for a local file are transferred to the remote file. For example, does the remote file become compressed and/or encrypted just by setting the flags? It may depend on the SFTP server and/or the remote filesystem.
(3) Dates/times are sent in GMT. SFTP servers should convert GMT times to local time zones.

Returns True for success, False for failure.

<Awaitable> Function CreateDirAsync(ByVal path As String) As IAsyncOperation(Of Boolean)

Creates a directory on the SFTP server.

Returns True for success, False for failure.

Sub Disconnect()

Disconnects from the SSH server.

<Awaitable> Function DownloadBdAsync(ByVal remoteFilePath As String, ByVal binData As BinData) As IAsyncOperation(Of Boolean)

Introduced in version 9.5.0.62

Downloads the contents of a remote file to a BinData object. (Appends to the BinData.)

Returns True for success, False for failure.

SFTP Upload and Download to a BinData Object

<Awaitable> Function DownloadFileAsync(ByVal handle As String, ByVal toFilename As String) As IAsyncOperation(Of Boolean)

Downloads a file from the SSH server to the local filesystem. There are no limitations on file size and the data is streamed from SSH server to the local file. handle is a file handle returned by a previous call to OpenFile.

Returns True for success, False for failure.

<Awaitable> Function DownloadFileByNameAsync(ByVal remoteFilePath As String, ByVal localFilePath As String) As IAsyncOperation(Of Boolean)

Simplified method for downloading files.

The last-modified date/time is only preserved when the PreserveDate property is set to True. (The default value of PreserveDate is False.)

Returns True for success, False for failure.

Understanding SFTP Absolute FilePaths

Async SFTP Progress Info

Change Remote Directory in SFTP

<Awaitable> Function DownloadSbAsync(ByVal remoteFilePath As String, ByVal charset As String, ByVal sb As StringBuilder) As IAsyncOperation(Of Boolean)

Introduced in version 9.5.0.62

Downloads the contents of a remote file to a StringBuilder object. (Appends to the StringBuilder.)

Returns True for success, False for failure.

SFTP Upload and Download to a StringBuilder Object

Function Eof(ByVal handle As String) As Boolean

Returns True if the last read operation for a handle reached the end of file. Otherwise returns False. If an invalid handle is passed, a value of True is returned.

<Awaitable> Function FileExistsAsync(ByVal remotePath As String, ByVal followLinks As Boolean) As IAsyncOperation(Of Integer)

Introduced in version 9.5.0.67

Returns a value to indicate whether the remote file exists or not. remotePath is the path of the remote file. If followLinks is True, then symbolic links will be followed on the server.

This method returns one of the following possible values:

  • -1: Unable to check. Examine the LastErrorText to determine the reason for failure.
  • 0: File does not exist.
  • 1: The regular file exists.
  • 2: It exists, but it is a directory.
  • 3: It exists, but it is a symlink (only possible if followLinks is False)
  • 4: It exists, but it is a special filesystem entry type.
  • 5: It exists, but it is an unkown filesystem entry type.
  • 6: It exists, but it is an socket filesystem entry type.
  • 7: It exists, but it is an char device entry type.
  • 8: It exists, but it is an block device entry type.
  • 9: It exists, but it is an FIFO entry type.

Note: The values greater than zero correspond to the possible values as specified in the SFTP protocol specification. A given value may not make sense on all operating systems.

<Awaitable> Function FsyncAsync(ByVal handle As String) As IAsyncOperation(Of Boolean)

Introduced in version 9.5.0.71

Causes the SFTP server to do an fsync on the open file. Specifically, this is directing the SFTP server to call fsync (https://linux.die.net/man/2/fsync) on the open file.

This method uses the fsync@openssh.com and only works for servers supporting the fsync@openssh.com extension.

Returns True for success, False for failure.

SFTP Fsync -- Flush an Open File on the Server

<Awaitable> Function GetFileCreateDtAsync(ByVal pathOrHandle As String, ByVal bFollowLinks As Boolean, ByVal bIsHandle As Boolean) As IAsyncOperation(Of CkDateTime)

Returns the create date/time for a file. pathOrHandle may be a remote filepath or an open handle string as returned by OpenFile. If pathOrHandle is a handle, then bIsHandle must be set to True, otherwise it should be False. If bFollowLinks is True, then symbolic links will be followed on the server.

Note: Servers running the SFTP v3 protocol or lower do not have the ability to return a file's creation date/time.

Returns Nothing on failure

<Awaitable> Function GetFileCreateTimeStrAsync(ByVal pathOrHandle As String, ByVal bFollowLinks As Boolean, ByVal bIsHandle As Boolean) As IAsyncOperation(Of String)

The same as GetFileCreateTime, except the date/time is returned as an RFC822 formatted string.

Returns Nothing on failure

<Awaitable> Function GetFileGroupAsync(ByVal pathOrHandle As String, ByVal bFollowLinks As Boolean, ByVal bIsHandle As Boolean) As IAsyncOperation(Of String)

Returns the group of a file. pathOrHandle may be a remote filepath or an open handle string as returned by OpenFile. If pathOrHandle is a handle, then bIsHandle must be set to True, otherwise it should be False. If bFollowLinks is True, then symbolic links will be followed on the server.

Note: Servers running the SFTP v3 protocol or lower do not have the ability to return a file's group name. Instead, the decimal GID of the file is returned.

Returns Nothing on failure

<Awaitable> Function GetFileLastAccessDtAsync(ByVal pathOrHandle As String, ByVal bFollowLinks As Boolean, ByVal bIsHandle As Boolean) As IAsyncOperation(Of CkDateTime)

Returns the last-access date/time for a file. pathOrHandle may be a remote filepath or an open handle string as returned by OpenFile. If pathOrHandle is a handle, then bIsHandle must be set to True, otherwise it should be False. If bFollowLinks is True, then symbolic links will be followed on the server.

Returns Nothing on failure

<Awaitable> Function GetFileLastAccessStrAsync(ByVal pathOrHandle As String, ByVal bFollowLinks As Boolean, ByVal bIsHandle As Boolean) As IAsyncOperation(Of String)

The same as GetFileLastAccess, except the date/time is returned as an RFC822 formatted string.

Returns Nothing on failure

<Awaitable> Function GetFileLastModifiedDtAsync(ByVal pathOrHandle As String, ByVal bFollowLinks As Boolean, ByVal bIsHandle As Boolean) As IAsyncOperation(Of CkDateTime)

Returns the last-modified date/time for a file. pathOrHandle may be a remote filepath or an open handle string as returned by OpenFile. If pathOrHandle is a handle, then bIsHandle must be set to True, otherwise it should be False. If bFollowLinks is True, then symbolic links will be followed on the server.

Returns Nothing on failure

<Awaitable> Function GetFileLastModifiedStrAsync(ByVal pathOrHandle As String, ByVal bFollowLinks As Boolean, ByVal bIsHandle As Boolean) As IAsyncOperation(Of String)

The same as GetFileLastModified, except the date/time is returned as an RFC822 formatted string.

Returns Nothing on failure

<Awaitable> Function GetFileOwnerAsync(ByVal pathOrHandle As String, ByVal bFollowLinks As Boolean, ByVal bIsHandle As Boolean) As IAsyncOperation(Of String)

Returns the owner of a file. pathOrHandle may be a remote filepath or an open handle string as returned by OpenFile. If pathOrHandle is a handle, then bIsHandle must be set to True, otherwise it should be False. If bFollowLinks is True, then symbolic links will be followed on the server.

Note: Servers running the SFTP v3 protocol or lower do not have the ability to return a file's owner name. Instead, the decimal UID of the file is returned.

Returns Nothing on failure

<Awaitable> Function GetFilePermissionsAsync(ByVal pathOrHandle As String, ByVal bFollowLinks As Boolean, ByVal bIsHandle As Boolean) As IAsyncOperation(Of Integer)

Returns the access permisssions flags of a file. pathOrHandle may be a remote filepath or an open handle string as returned by OpenFile. If pathOrHandle is a handle, then bIsHandle must be set to True, otherwise it should be False. If bFollowLinks is True, then symbolic links will be followed on the server.

<Awaitable> Function GetFileSize32Async(ByVal pathOrHandle As String, ByVal bFollowLinks As Boolean, ByVal bIsHandle As Boolean) As IAsyncOperation(Of Integer)

Returns the size in bytes of a file on the SSH server. If the file size exceeds what can be represented in 32-bits, a value of -1 is returned. pathOrHandle may be a remote filepath or an open handle string as returned by OpenFile. If pathOrHandle is a handle, then bIsHandle must be set to True, otherwise it should be False. If bFollowLinks is True, then symbolic links will be followed on the server.

<Awaitable> Function GetFileSize64Async(ByVal pathOrHandle As String, ByVal bFollowLinks As Boolean, ByVal bIsHandle As Boolean) As IAsyncOperation(Of Int64)

Returns a 64-bit integer containing the size (in bytes) of a file on the SSH server. pathOrHandle may be a remote filepath or an open handle string as returned by OpenFile. If pathOrHandle is a handle, then bIsHandle must be set to True, otherwise it should be False. If bFollowLinks is True, then symbolic links will be followed on the server.

<Awaitable> Function GetFileSizeStrAsync(ByVal pathOrHandle As String, ByVal bFollowLinks As Boolean, ByVal bIsHandle As Boolean) As IAsyncOperation(Of String)

Returns the size in bytes (in decimal string form) of a file on the SSH server. pathOrHandle may be a remote filepath or an open handle string as returned by OpenFile. If pathOrHandle is a handle, then bIsHandle must be set to True, otherwise it should be False. If bFollowLinks is True, then symbolic links will be followed on the server.

Note: This method exists for environments that do not have 64-bit integer support. The Add64 method is provided for 64-bit addition, and other methods such as ReadFileBytes64s allow for 64-bit values to be passed as strings.

Returns Nothing on failure

<Awaitable> Function HardLinkAsync(ByVal oldPath As String, ByVal newPath As String) As IAsyncOperation(Of Boolean)

Introduced in version 9.5.0.71

Creates a hard link on the server using the hardlink@openssh.com extension. This only works for SFTP servers that support the hardlink@openssh.com extension.

Returns True for success, False for failure.

SFTP HardLink - Create a Hard Link using the hardlink@openssh.com Extension

<Awaitable> Function InitializeSftpAsync() As IAsyncOperation(Of Boolean)

Intializes the SFTP subsystem. This should be called after connecting and authenticating. An SFTP session always begins by first calling Connect to connect to the SSH server, then calling either AuthenticatePw or AuthenticatePk to login, and finally calling InitializeSftp.

Important: When reporting problems, please send the full contents of the LastErrorText property to support@chilkatsoft.com.

If this method fails, the reason may be present in the InitializeFailCode and InitializeFailReason properties (assuming the failure occurred when trying to open the SFTP session channel).

Returns True for success, False for failure.

Error Explained: Received FAILURE response to subsystem request.

Function LastReadFailed(ByVal handle As String) As Boolean

Returns True if the last read on the specified handle failed. Otherwise returns False.

Function LastReadNumBytes(ByVal handle As String) As Integer

Returns the number of bytes received by the last read on a specified channel.

<Awaitable> Function OpenDirAsync(ByVal path As String) As IAsyncOperation(Of String)

Opens a directory for reading. To get a directory listing, first open the directory by calling this method, then call ReadDir to read the directory, and finally call CloseHandle to close the directory.

The SFTP protocol represents file names as strings. File names are assumed to use the slash ('/') character as a directory separator.

File names 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). Note that identifying the user is assumed to take place outside of this protocol.

Servers SHOULD interpret a path name component ".." as referring to the parent directory, and "." as referring to the current directory.

An empty path name is valid, and it refers to the user's default directory (usually the user's home directory).

Please note: This method does NOT "change" the remote working directory. It is only a method for opening a directory for the purpose of reading the directory listing.

SFTP is Secure File Transfer over SSH. It is not the FTP protocol. There is no similarity or relationship between FTP and SFTP. Therefore, concepts such as "current remote directory" that exist in FTP do not exist with SFTP. With the SFTP protocol, the current directory will always be the home directory of the user account used during SSH/SFTP authentication. You may pass relative or absolute directory/file paths. A relative path is always relative to the home directory of the SSH user account.

Returns Nothing on failure

Understanding SFTP Absolute FilePaths

<Awaitable> Function OpenFileAsync(ByVal remotePath As String, ByVal access As String, ByVal createDisposition As String) As IAsyncOperation(Of String)

Opens or creates a file on the remote system. Returns a handle which may be passed to methods for reading and/or writing the file. The remotePath is the remote file path (the path to the file on the server). When the application is finished with the handle, it should call CloseHandle(remotePath).

access should be one of the following strings: "readOnly", "writeOnly", or "readWrite".

createDisposition is a comma-separated list of keywords to provide more control over how the file is opened or created. One of the following keywords must be present: "createNew", "createTruncate", "openExisting", "openOrCreate", or "truncateExisting". All other keywords are optional. The list of keywords and their meanings are shown here:

createNew
A new file is created; if the file already exists the method fails.

createTruncate
A new file is created; if the file already exists, it is opened and truncated.

openExisting
An existing file is opened. If the file does not exist the method fails.

openOrCreate
If the file exists, it is opened. If the file does not exist, it is created.

truncateExisting
An existing file is opened and truncated. If the file does not exist the method fails.

appendData
Data is always written at the end of the file. Data is not required to be appended atomically. This means that if multiple writers attempt to append data simultaneously, data from the first may be lost.

appendDataAtomic
Data is always written at the end of the file. Data MUST be written atomically so that there is no chance that multiple appenders can collide and result in data being lost.

textMode
Indicates that the server should treat the file as text and convert it to the canonical newline convention in use. When a file is opened with this flag, data is always appended to the end of the file. Servers MUST process multiple, parallel reads and writes correctly in this mode.

blockRead
The server MUST guarantee that no other handle has been opened with read access, and that no other handle will be opened with read access until the client closes the handle. (This MUST apply both to other clients and to other processes on the server.) In a nutshell, this opens the file in non-sharing mode.

blockWrite
The server MUST guarantee that no other handle has been opened with write access, and that no other handle will be opened with write access until the client closes the handle. (This MUST apply both to other clients and to other processes on the server.) In a nutshell, this opens the file in non-sharing mode.

blockDelete
The server MUST guarantee that the file itself is not deleted in any other way until the client closes the handle. No other client or process is allowed to open the file with delete access.

blockAdvisory
If set, the above "block" modes are advisory. In advisory mode, only other accesses that specify a "block" mode need be considered when determining whether the "block" can be granted, and the server need not prevent I/O operations that violate the block mode. The server MAY perform mandatory locking even if the blockAdvisory flag is set.

noFollow
If the final component of the path is a symlink, then the open MUST fail.

deleteOnClose
The file should be deleted when the last handle to it is closed. (The last handle may not be an sftp-handle.) This MAY be emulated by a server if the OS doesn't support it by deleting the file when this handle is closed.

accessAuditAlarmInfo
The client wishes the server to enable any privileges or extra capabilities that the user may have in to allow the reading and writing of AUDIT or ALARM access control entries.

accessBackup
The client wishes the server to enable any privileges or extra capabilities that the user may have in order to bypass normal access checks for the purpose of backing up or restoring files.

backupStream
This flag indicates that the client wishes to read or write a backup stream. A backup stream is a system dependent structured data stream that encodes all the information that must be preserved in order to restore the file from backup medium. The only well defined use for backup stream data read in this fashion is to write it to the same server to a file also opened using the backupStream flag. However, if the server has a well defined backup stream format, there may be other uses for this data outside the scope of this protocol.

IMPORANT: If remotePath is a filename with no path, such as "test.txt", and the server responds with a "Folder not found" error, then try prepending "./" to the remotePath. For example, instead of passing "test.txt", try "./test.txt".

Returns Nothing on failure

Understanding SFTP Absolute FilePaths

SFTP Where Did My Upload Go?

Change Remote Directory in SFTP

<Awaitable> Function ReadDirAsync(ByVal handle As String) As IAsyncOperation(Of SFtpDir)

Reads the contents of a directory and returns the directory listing (as an object). The handle returned by OpenDir should be passed to this method.

Returns Nothing on failure

<Awaitable> Function ReadFileBytesAsync(ByVal handle As String, ByVal numBytes As Integer) As IAsyncOperation(Of Byte())

Reads file data from a remote file on the SSH server. The handle is a file handle returned by the OpenFile method. The numBytes is the maximum number of bytes to read. If the end-of-file is reached prior to reading the number of requested bytes, then fewer bytes may be returned.

To read an entire file, one may call ReadFileBytes repeatedly until Eof(handle) returns True.

Returns an empty byte array on failure

<Awaitable> Function ReadFileBytes32Async(ByVal handle As String, ByVal offset As Integer, ByVal numBytes As Integer) As IAsyncOperation(Of Byte())

Reads file data from a remote file on the SSH server. The handle is a file handle returned by the OpenFile method. The offset is measured in bytes relative to the beginning of the file. (64-bit offsets are supported via the ReadFileBytes64 and ReadFileBytes64s methods.) The offset is ignored if the "textMode" flag was specified during the OpenFile. The numBytes is the maximum number of bytes to read. If the end-of-file is reached prior to reading the number of requested bytes, then fewer bytes may be returned.

Returns an empty byte array on failure

<Awaitable> Function ReadFileBytes64Async(ByVal handle As String, ByVal offset As Int64, ByVal numBytes As Integer) As IAsyncOperation(Of Byte())

Reads file data from a remote file on the SSH server. The handle is a file handle returned by the OpenFile method. The offset is a 64-bit integer measured in bytes relative to the beginning of the file. The offset is ignored if the "textMode" flag was specified during the OpenFile. The numBytes is the maximum number of bytes to read. If the end-of-file is reached prior to reading the number of requested bytes, then fewer bytes may be returned.

Returns an empty byte array on failure

<Awaitable> Function ReadFileBytes64sAsync(ByVal handle As String, ByVal offset As String, ByVal numBytes As Integer) As IAsyncOperation(Of Byte())

(This method exists for systems that do not support 64-bit integers. The 64-bit integer offset is passed as a decimal string instead.)

Reads file data from a remote file on the SSH server. The handle is a file handle returned by the OpenFile method. The offset is a 64-bit integer represented as a decimal string. It represents an offset in bytes from the beginning of the file. The offset is ignored if the "textMode" flag was specified during the OpenFile. The numBytes is the maximum number of bytes to read. If the end-of-file is reached prior to reading the number of requested bytes, then fewer bytes may be returned.

Returns an empty byte array on failure

<Awaitable> Function ReadFileTextAsync(ByVal handle As String, ByVal numBytes As Integer, ByVal charset As String) As IAsyncOperation(Of String)

This method is identical to ReadFileBytes except for one thing: The bytes are interpreted according to the specified charset (i.e. the character encoding) and returned as a string. A list of supported charset values may be found on this page: Supported Charsets.

Note: If the charset is an encoding where a single character might be represented in multiple bytes (such as utf-8, Shift_JIS, etc.) then there is a risk that the very last character may be partially read. This is because the method specifies the number of bytes to read, not the number of characters. This is never a problem with character encodings that use a single byte per character, such as all of the iso-8859-* encodings, or the Windows-* encodings.

To read an entire file, one may call ReadFileText repeatedly until Eof(handle) returns True.

Returns Nothing on failure

<Awaitable> Function ReadFileText32Async(ByVal handle As String, ByVal offset As Integer, ByVal numBytes As Integer, ByVal charset As String) As IAsyncOperation(Of String)

This method is identical to ReadFileBytes32 except for one thing: The bytes are interpreted according to the specified charset (i.e. the character encoding) and returned as a string. A list of supported charset values may be found on this page: Supported Charsets.

Note: If the charset is an encoding where a single character might be represented in multiple bytes (such as utf-8, Shift_JIS, etc.) then there is a risk that the very last character may be partially read. This is because the method specifies the number of bytes to read, not the number of characters. This is never a problem with character encodings that use a single byte per character, such as all of the iso-8859-* encodings, or the Windows-* encodings.

Returns Nothing on failure

<Awaitable> Function ReadFileText64Async(ByVal handle As String, ByVal offset As Int64, ByVal numBytes As Integer, ByVal charset As String) As IAsyncOperation(Of String)

This method is identical to ReadFileBytes64 except for one thing: The bytes are interpreted according to the specified charset (i.e. the character encoding) and returned as a string. A list of supported charset values may be found on this page: Supported Charsets.

Note: If the charset is an encoding where a single character might be represented in multiple bytes (such as utf-8, Shift_JIS, etc.) then there is a risk that the very last character may be partially read. This is because the method specifies the number of bytes to read, not the number of characters. This is never a problem with character encodings that use a single byte per character, such as all of the iso-8859-* encodings, or the Windows-* encodings.

Returns Nothing on failure

<Awaitable> Function ReadFileText64sAsync(ByVal handle As String, ByVal offset As String, ByVal numBytes As Integer, ByVal charset As String) As IAsyncOperation(Of String)

This method is identical to ReadFileBytes64s except for one thing: The bytes are interpreted according to the specified charset (i.e. the character encoding) and returned as a string. A list of supported charset values may be found on this page: Supported Charsets.

Note: If the charset is an encoding where a single character might be represented in multiple bytes (such as utf-8, Shift_JIS, etc.) then there is a risk that the very last character may be partially read. This is because the method specifies the number of bytes to read, not the number of characters. This is never a problem with character encodings that use a single byte per character, such as all of the iso-8859-* encodings, or the Windows-* encodings.

Returns Nothing on failure

<Awaitable> Function ReadLinkAsync(ByVal path As String) As IAsyncOperation(Of String)

Introduced in version 9.5.0.71

Returns the target of a symbolic link on the server. The path is the path of the symbolic link on the server.

Returns Nothing on failure

SFTP ReadLink - Get the Target of a Symbolic Link on the Server

<Awaitable> Function RealPathAsync(ByVal originalPath As String, ByVal composePath As String) As IAsyncOperation(Of String)

This method can be used to have the server canonicalize any given path name to an absolute path. This is useful for converting path names containing ".." components or relative pathnames without a leading slash into absolute paths. The absolute path is returned by this method.

originalPath is the first component of the path which the client wishes resolved into a absolute canonical path. This may be the entire path.

The composePath is a path which the client wishes the server to compose with the original path to form the new path. This field is optional and may be set to a zero-length string.

The server will take the originalPath and apply the composePath as a modification to it. composePath may be relative to originalPath or may be an absolute path, in which case originalPath will be discarded. The composePath may be zero length.

Note: Servers running SFTP v4 and below do not support composePath.

Returns Nothing on failure

<Awaitable> Function RemoveDirAsync(ByVal path As String) As IAsyncOperation(Of Boolean)

Deletes a directory on the remote server. Most (if not all) SFTP servers require that the directorybe empty of files before it may be deleted.

Returns True for success, False for failure.

<Awaitable> Function RemoveFileAsync(ByVal filename As String) As IAsyncOperation(Of Boolean)

Deletes a file on the SFTP server.

Returns True for success, False for failure.

Understanding SFTP Absolute FilePaths

<Awaitable> Function RenameFileOrDirAsync(ByVal oldPath As String, ByVal newPath As String) As IAsyncOperation(Of Boolean)

Renames a file or directory on the SFTP server.

Returns True for success, False for failure.

<Awaitable> Function ResumeDownloadFileByNameAsync(ByVal remoteFilePath As String, ByVal localFilePath As String) As IAsyncOperation(Of Boolean)

Resumes an SFTP download. The size of the localFilePath is checked and the download begins at the appropriate position in the remoteFilePath. If localFilePath is empty or non-existent, then this method is identical to DownloadFileByName. If the localFilePath is already fully downloaded, then no additional data is downloaded and the method will return True.

Returns True for success, False for failure.

SFTP Resume Download Example

<Awaitable> Function ResumeUploadFileByNameAsync(ByVal remoteFilePath As String, ByVal localFilePath As String) As IAsyncOperation(Of Boolean)

Resumes a file upload to the SFTP/SSH server. The size of the remoteFilePath is first checked to determine the starting offset for the upload. If remoteFilePath is empty or does not exist, this method is equivalent to UploadFileByName. If remoteFilePath is already fully uploaded (i.e. it's size is equal to localFilePath), then no additional bytes are uploaded and True is returned.

Returns True for success, False for failure.

SFTP Resume Upload Example

<Awaitable> Function SendIgnoreAsync() As IAsyncOperation(Of Boolean)

Introduced in version 9.5.0.66

Sends an IGNORE message to the SSH server. This is one way of verifying that the connection to the SSH server is open and valid. The SSH server does not respond to an IGNORE message. It simply ignores it. IGNORE messages are not associated with a channel (i.e., you do not need to first open a channel prior to sending an IGNORE message).

Returns True for success, False for failure.

<Awaitable> Function SetCreateDtAsync(ByVal pathOrHandle As String, ByVal isHandle As Boolean, ByVal createDateTime As CkDateTime) As IAsyncOperation(Of Boolean)

Sets the create date/time for a file on the server. The pathOrHandle may be a filepath or the handle of a currently open file. isHandle should be set to True if the pathOrHandle is a handle, otherwise set isHandle to False.

Note: Servers running version 3 or lower of the SFTP protocol do not support setting the create date/time.

Returns True for success, False for failure.

<Awaitable> Function SetCreateTimeStrAsync(ByVal pathOrHandle As String, ByVal bIsHandle As Boolean, ByVal dateTimeStr As String) As IAsyncOperation(Of Boolean)

The same as SetCreateTime, except the date/time is passed as an RFC822 formatted string.

Returns True for success, False for failure.

<Awaitable> Function SetLastAccessDtAsync(ByVal pathOrHandle As String, ByVal isHandle As Boolean, ByVal accessDateTime As CkDateTime) As IAsyncOperation(Of Boolean)

Sets the last-access date/time for a file on the server. The pathOrHandle may be a filepath or the handle of a currently open file. isHandle should be set to True if the pathOrHandle is a handle, otherwise set isHandle to False.

Returns True for success, False for failure.

<Awaitable> Function SetLastAccessTimeStrAsync(ByVal pathOrHandle As String, ByVal bIsHandle As Boolean, ByVal dateTimeStr As String) As IAsyncOperation(Of Boolean)

The same as SetLastAccessTime, except the date/time is passed as an RFC822 formatted string.

Returns True for success, False for failure.

<Awaitable> Function SetLastModifiedDtAsync(ByVal pathOrHandle As String, ByVal isHandle As Boolean, ByVal modifiedDateTime As CkDateTime) As IAsyncOperation(Of Boolean)

Sets the last-modified date/time for a file on the server. The pathOrHandle may be a filepath or the handle of a currently open file. isHandle should be set to True if the pathOrHandle is a handle, otherwise set isHandle to False.

Returns True for success, False for failure.

<Awaitable> Function SetLastModifiedTimeStrAsync(ByVal pathOrHandle As String, ByVal bIsHandle As Boolean, ByVal dateTimeStr As String) As IAsyncOperation(Of Boolean)

The same as SetLastModifiedTime, except the date/time is passed as an RFC822 formatted string.

Returns True for success, False for failure.

<Awaitable> Function SetOwnerAndGroupAsync(ByVal pathOrHandle As String, ByVal isHandle As Boolean, ByVal owner As String, ByVal group As String) As IAsyncOperation(Of Boolean)

Sets the owner and group for a file on the server. The pathOrHandle may be a filepath or the handle of a currently open file. isHandle should be set to True if the pathOrHandle is a handle, otherwise set isHandle to False.

Note: Servers running version 3 or lower of the SFTP protocol do not support setting the owner and group.

Returns True for success, False for failure.

<Awaitable> Function SetPermissionsAsync(ByVal pathOrHandle As String, ByVal isHandle As Boolean, ByVal permissions As Integer) As IAsyncOperation(Of Boolean)

Sets the permissions for a file on the server. The pathOrHandle may be a filepath or the handle of a currently open file. isHandle should be set to True if the pathOrHandle is a handle, otherwise set isHandle to False.

Returns True for success, False for failure.

<Awaitable> Function SymLinkAsync(ByVal oldPath As String, ByVal newPath As String) As IAsyncOperation(Of Boolean)

Introduced in version 9.5.0.71

Create a symbolic link from oldpath to newpath on the server filesystem.

Returns True for success, False for failure.

SFTP SymLink - Create Symbolic Link on Server

<Awaitable> Function SyncTreeDownloadAsync(ByVal remoteRoot As String, ByVal localRoot As String, ByVal mode As Integer, ByVal recurse As Boolean) As IAsyncOperation(Of Boolean)

Downloads files from the SFTP server to a local directory tree. Synchronization modes include:

mode=0: Download all files
mode=1: Download all files that do not exist on the local filesystem.
mode=2: Download newer or non-existant files.
mode=3: Download only newer files. If a file does not already exist on the local filesystem, it is not downloaded from the server.
mode=5: Download only missing files or files with size differences.
mode=6: Same as mode 5, but also download newer files.
mode=99: Do not download files, but instead delete remote files that do not exist locally.

If recurse is False, then the remotel directory tree is not recursively descended.

Returns True for success, False for failure.

SFTP Download all Files in a Directory

SFTP Synchronize Directory Tree - Download

<Awaitable> Function SyncTreeUploadAsync(ByVal localBaseDir As String, ByVal remoteBaseDir As String, ByVal mode As Integer, ByVal bRecurse As Boolean) As IAsyncOperation(Of Boolean)

Uploads a directory tree from the local filesystem to the SFTP server. Synchronization modes include:

mode=0: Upload all files
mode=1: Upload all files that do not exist on the server.
mode=2: Upload newer or non-existant files.
mode=3: Upload only newer files. If a file does not already exist on the server, it is not uploaded.
mode=4: transfer missing files or files with size differences.
mode=5: same as mode 4, but also newer files.

If bRecurse is False, then the local directory tree is not recursively descended.

Returns True for success, False for failure.

SFTP Upload - Synchronize Directory Tree

Function UnlockComponent(ByVal unlockCode As String) As Boolean

Unlocks the component. This must be called once prior to calling any other method. A fully-functional 30-day trial is automatically started when an arbitrary string is passed to this method. For example, passing "Hello", or "abc123" will unlock the component for the 1st thirty days after the initial install.

A purchased unlock code for SFTP should contain the substring ".SS" or "SSH" (or it can be a Bundle unlock code) because SFTP is the Secure File Transfer protocol over SSH. It is a sub-system of the SSH protocol. It is not the FTP protocol. If the Chilkat FTP2 component/library should be used for the FTP protocol.

Returns True for success, False for failure.

Diagnosing UnlockComponent Problems

UnlockComponent LastErrorText shows exact string passed to it.

Verify UnlockComponent Success w/ Purchased Unlock Code

LastErrorText Standard Information

<Awaitable> Function UploadBdAsync(ByVal binData As BinData, ByVal remoteFilePath As String) As IAsyncOperation(Of Boolean)

Introduced in version 9.5.0.62

Uploads the contents of a BinData to a remote file.

Returns True for success, False for failure.

SFTP Upload and Download to a BinData Object

<Awaitable> Function UploadFileAsync(ByVal handle As String, ByVal fromFilename As String) As IAsyncOperation(Of Boolean)

Uploads a file from the local filesystem to the SFTP server. handle is a handle of a currently open file (obtained by calling the OpenFile method). fromFilename is the local file path of the file to be uploaded.

Returns True for success, False for failure.

<Awaitable> Function UploadFileByNameAsync(ByVal remoteFilePath As String, ByVal localFilePath As String) As IAsyncOperation(Of Boolean)

Simplified method for uploading a file to the SFTP/SSH server.

The last-modified date/time is only preserved if the PreserveDate property is set to True. This behavior of maintaining the last-mod date/time was introduced in v9.5.0.40.

Returns True for success, False for failure.

SFTP Simplified Upload Example

Change Remote Directory in SFTP

<Awaitable> Function UploadSbAsync(ByVal sb As StringBuilder, ByVal remoteFilePath As String, ByVal charset As String, ByVal includeBom As Boolean) As IAsyncOperation(Of Boolean)

Introduced in version 9.5.0.62

Uploads the contents of a StringBuilder to a remote file.

Returns True for success, False for failure.

SFTP Upload and Download to a StringBuilder Object

<Awaitable> Function WriteFileBytesAsync(ByVal handle As String, ByVal byteData As Byte()) As IAsyncOperation(Of Boolean)

Appends byte data to an open file. The handle is a file handle returned by the OpenFile method.

Returns True for success, False for failure.

<Awaitable> Function WriteFileBytes32Async(ByVal handle As String, ByVal offset As Integer, ByVal data As Byte()) As IAsyncOperation(Of Boolean)

Writes data to an open file at a specific offset from the beginning of the file. The handle is a file handle returned by the OpenFile method. The offset is an offset from the beginning of the file.

Returns True for success, False for failure.

<Awaitable> Function WriteFileBytes64Async(ByVal handle As String, ByVal offset64 As Int64, ByVal data As Byte()) As IAsyncOperation(Of Boolean)

Writes data to an open file at a specific offset from the beginning of the file. The handle is a file handle returned by the OpenFile method. The offset64 is an offset from the beginning of the file.

Returns True for success, False for failure.

<Awaitable> Function WriteFileBytes64sAsync(ByVal handle As String, ByVal offset64 As String, ByVal data As Byte()) As IAsyncOperation(Of Boolean)

Writes data to an open file at a specific offset from the beginning of the file. The handle is a file handle returned by the OpenFile method. The offset64 is an offset (in decimal string format) from the beginning of the file.

Returns True for success, False for failure.

<Awaitable> Function WriteFileTextAsync(ByVal handle As String, ByVal charset As String, ByVal textData As String) As IAsyncOperation(Of Boolean)

Appends character data to an open file. The handle is a file handle returned by the OpenFile method. charset is a character encoding and is typically set to values such as "ansi", "utf-8", "windows-1252", etc. A list of supported character encodings is found on this page: Supported Charsets.

Note: It is necessary to specify the character encoding because in many programming languages, strings are represented as Unicode (2 bytes/char) and in most cases one does not wish to write Unicode chars to a text file (although it is possible by setting charset = "Unicode").

Returns True for success, False for failure.

<Awaitable> Function WriteFileText32Async(ByVal handle As String, ByVal offset32 As Integer, ByVal charset As String, ByVal textData As String) As IAsyncOperation(Of Boolean)

Writes character data to an open file at a specific offset from the beginning of the file. The handle is a file handle returned by the OpenFile method. charset is a character encoding and is typically set to values such as "ansi", "utf-8", "windows-1252", etc. A list of supported character encodings is found on this page: Supported Charsets.

Returns True for success, False for failure.

<Awaitable> Function WriteFileText64Async(ByVal handle As String, ByVal offset64 As Int64, ByVal charset As String, ByVal textData As String) As IAsyncOperation(Of Boolean)

Writes character data to an open file at a specific offset from the beginning of the file. The handle is a file handle returned by the OpenFile method. charset is a character encoding and is typically set to values such as "ansi", "utf-8", "windows-1252", etc. A list of supported character encodings is found on this page: Supported Charsets.

Returns True for success, False for failure.

<Awaitable> Function WriteFileText64sAsync(ByVal handle As String, ByVal offset64 As String, ByVal charset As String, ByVal textData As String) As IAsyncOperation(Of Boolean)

Writes character data to an open file at a specific offset from the beginning of the file. The handle is a file handle returned by the OpenFile method. The offset64 is an offset (in decimal string format) from the beginning of the file. charset is a character encoding and is typically set to values such as "ansi", "utf-8", "windows-1252", etc. A list of supported character encodings is found on this page: Supported Charsets.

Returns True for success, False for failure.

Events