Chilkat_9_5_0.SFtp PHP ActiveX Reference Documentation

Chilkat_9_5_0.SFtp

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

Object Creation

$obj = new COM("Chilkat_9_5_0.SFtp");

Properties

bool AbortCurrent

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

VARIANT AccumulateBuffer (read-only)

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.

int AuthFailReason (read-only)

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.

int BandwidthThrottleDown

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.

int BandwidthThrottleUp

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

string ClientIdentifier

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

string ClientIpAddress

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

int ConnectTimeoutMs

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

string DebugLogFilePath

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.

int DisconnectCode (read-only)

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

string DisconnectReason (read-only)

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.

bool EnableCache

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.

bool EnableCompression

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.

string FilenameCharset

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.

string ForceCipher

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.

bool ForceV3

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.

string HostKeyAlg

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.

string HostKeyFingerprint (read-only)

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"

string HttpProxyAuthMethod

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

string HttpProxyDomain

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

string HttpProxyHostname

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

string HttpProxyPassword

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

int HttpProxyPort

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

string HttpProxyUsername

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

int IdleTimeoutMs

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

bool IncludeDotDirs

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

int InitializeFailCode (read-only)

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

string InitializeFailReason (read-only)

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

bool IsConnected (read-only)

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.

bool KeepSessionLog

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.

VARIANT LastBinaryResult (read-only)

Introduced in version 9.5.0.52

The binary data returned by the last (binary data returning) method called. Only available if Chilkat.Global.KeepBinaryResult is set to true. This provides a means for obtaining large varbinary results in the SQL Server environment (where limitations exist in getting large amounts of data returned by method calls, but where temp tables can be used for binary properties).

string LastErrorHtml (read-only)

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.

string LastErrorText (read-only)

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

string LastErrorXml (read-only)

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.

bool LastMethodSuccess

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.

string LastStringResult (read-only)

Introduced in version 9.5.0.52

The string return value of the last (string returning) method called. Only available if Chilkat.Global.KeepStringResult is set to true. This provides a means for obtaining large string results in the SQL Server environment (where limitations exist in getting long strings returned by method calls, but where temp tables can be used for string properties).

Long Strings Returned by ActiveX Methods in SQL Server

int LastStringResultLen (read-only)

Introduced in version 9.5.0.53

The length, in characters, of the string contained in the LastStringResult property.

int MaxPacketSize

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

bool PasswordChangeRequested (read-only)

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|

bool PreferIpv6

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.

bool PreserveDate

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.

int ProtocolVersion (read-only)

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.

string ReadDirMustMatch

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.

string ReadDirMustNotMatch

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.

string ServerIdentifier (read-only)

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

string SessionLog (read-only)

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.

string SocksHostname

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

string SocksPassword

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

int SocksPort

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

string SocksUsername

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

int SocksVersion

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.

int SoRcvBuf

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

int SoSndBuf

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

string SyncDirectives

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.

string SyncedFiles

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.

string SyncMustMatch

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.

string SyncMustNotMatch

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.

bool TcpNoDelay

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.

int UploadChunkSize

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.

bool UtcMode

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

bool VerboseLogging

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.

string Version (read-only)

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

int XferByteCount (read-only)

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

int AccumulateBytes(string handle, int maxBytes)

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.

Chilkat_9_5_0.Task AccumulateBytesAsync(string handle, int maxBytes)

Creates an asynchronous task to call the AccumulateBytes method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns null on failure

How to Run an Asynchronous Task

string Add64(string n1, string n2)

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 null on failure

bool AuthenticatePk(string username, Chilkat_9_5_0.SshKey privateKey)

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

Chilkat_9_5_0.Task AuthenticatePkAsync(string username, Chilkat_9_5_0.SshKey privateKey)

Creates an asynchronous task to call the AuthenticatePk method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns null on failure

How to Run an Asynchronous Task

bool AuthenticatePw(string login, string password)

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.

Chilkat_9_5_0.Task AuthenticatePwAsync(string login, string password)

Creates an asynchronous task to call the AuthenticatePw method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns null on failure

How to Run an Asynchronous Task

bool AuthenticatePwPk(string username, string password, Chilkat_9_5_0.SshKey privateKey)

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.

Chilkat_9_5_0.Task AuthenticatePwPkAsync(string username, string password, Chilkat_9_5_0.SshKey privateKey)

Creates an asynchronous task to call the AuthenticatePwPk method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns null on failure

How to Run an Asynchronous Task

bool AuthenticateSecPw(Chilkat_9_5_0.SecureString login, Chilkat_9_5_0.SecureString password)

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

Chilkat_9_5_0.Task AuthenticateSecPwAsync(Chilkat_9_5_0.SecureString login, Chilkat_9_5_0.SecureString password)

Introduced in version 9.5.0.71

Creates an asynchronous task to call the AuthenticateSecPw method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns null on failure

How to Run an Asynchronous Task

bool AuthenticateSecPwPk(Chilkat_9_5_0.SecureString username, Chilkat_9_5_0.SecureString password, Chilkat_9_5_0.SshKey privateKey)

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.

Chilkat_9_5_0.Task AuthenticateSecPwPkAsync(Chilkat_9_5_0.SecureString username, Chilkat_9_5_0.SecureString password, Chilkat_9_5_0.SshKey privateKey)

Introduced in version 9.5.0.71

Creates an asynchronous task to call the AuthenticateSecPwPk method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns null on failure

How to Run an Asynchronous Task

void ClearAccumulateBuffer()

Clears the contents of the AccumulateBuffer property.

void ClearCache()

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

void ClearSessionLog()

Clears the contents of the SessionLog property.

bool CloseHandle(string handle)

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.

Chilkat_9_5_0.Task CloseHandleAsync(string handle)

Creates an asynchronous task to call the CloseHandle method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns null on failure

How to Run an Asynchronous Task

bool Connect(string domainName, int port)

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.

Chilkat_9_5_0.Task ConnectAsync(string domainName, int port)

Creates an asynchronous task to call the Connect method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns null on failure

How to Run an Asynchronous Task

bool ConnectThroughSsh(Chilkat_9_5_0.Ssh sshConn, string hostname, int port)

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

Chilkat_9_5_0.Task ConnectThroughSshAsync(Chilkat_9_5_0.Ssh sshConn, string hostname, int port)

Introduced in version 9.5.0.55

Creates an asynchronous task to call the ConnectThroughSsh method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns null on failure

How to Run an Asynchronous Task

bool CopyFileAttr(string localFilename, string remoteFilename, bool isHandle)

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.

Chilkat_9_5_0.Task CopyFileAttrAsync(string localFilename, string remoteFilename, bool isHandle)

Creates an asynchronous task to call the CopyFileAttr method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns null on failure

How to Run an Asynchronous Task

bool CreateDir(string path)

Creates a directory on the SFTP server.

Returns true for success, false for failure.

Chilkat_9_5_0.Task CreateDirAsync(string path)

Creates an asynchronous task to call the CreateDir method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns null on failure

How to Run an Asynchronous Task

void Disconnect()

Disconnects from the SSH server.

bool DownloadBd(string remoteFilePath, Chilkat_9_5_0.BinData binData)

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

Chilkat_9_5_0.Task DownloadBdAsync(string remoteFilePath, Chilkat_9_5_0.BinData binData)

Introduced in version 9.5.0.62

Creates an asynchronous task to call the DownloadBd method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns null on failure

How to Run an Asynchronous Task

bool DownloadFile(string handle, string toFilename)

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.

Chilkat_9_5_0.Task DownloadFileAsync(string handle, string toFilename)

Creates an asynchronous task to call the DownloadFile method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns null on failure

How to Run an Asynchronous Task

bool DownloadFileByName(string remoteFilePath, string localFilePath)

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

Chilkat_9_5_0.Task DownloadFileByNameAsync(string remoteFilePath, string localFilePath)

Creates an asynchronous task to call the DownloadFileByName method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns null on failure

How to Run an Asynchronous Task

bool DownloadSb(string remoteFilePath, string charset, Chilkat_9_5_0.StringBuilder sb)

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

Chilkat_9_5_0.Task DownloadSbAsync(string remoteFilePath, string charset, Chilkat_9_5_0.StringBuilder sb)

Introduced in version 9.5.0.62

Creates an asynchronous task to call the DownloadSb method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns null on failure

How to Run an Asynchronous Task

bool Eof(string handle)

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.

int FileExists(string remotePath, bool followLinks)

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.

Chilkat_9_5_0.Task FileExistsAsync(string remotePath, bool followLinks)

Introduced in version 9.5.0.67

Creates an asynchronous task to call the FileExists method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns null on failure

How to Run an Asynchronous Task

bool Fsync(string handle)

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

Chilkat_9_5_0.Task FsyncAsync(string handle)

Introduced in version 9.5.0.71

Creates an asynchronous task to call the Fsync method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns null on failure

How to Run an Asynchronous Task

Chilkat_9_5_0.CkDateTime GetFileCreateDt(string pathOrHandle, bool bFollowLinks, bool bIsHandle)

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 null on failure

Chilkat_9_5_0.Task GetFileCreateDtAsync(string pathOrHandle, bool bFollowLinks, bool bIsHandle)

Creates an asynchronous task to call the GetFileCreateDt method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns null on failure

How to Run an Asynchronous Task

How to Return an Object from an Async Task

Date GetFileCreateTime(string pathOrHandle, bool bFollowLinks, bool bIsHandle)

This method is deprecated. It will be removed in a future version.

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.

string GetFileCreateTimeStr(string pathOrHandle, bool bFollowLinks, bool bIsHandle)

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

Returns null on failure

Chilkat_9_5_0.Task GetFileCreateTimeStrAsync(string pathOrHandle, bool bFollowLinks, bool bIsHandle)

Creates an asynchronous task to call the GetFileCreateTimeStr method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns null on failure

How to Run an Asynchronous Task

string GetFileGroup(string pathOrHandle, bool bFollowLinks, bool bIsHandle)

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 null on failure

Chilkat_9_5_0.Task GetFileGroupAsync(string pathOrHandle, bool bFollowLinks, bool bIsHandle)

Creates an asynchronous task to call the GetFileGroup method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns null on failure

How to Run an Asynchronous Task

Date GetFileLastAccess(string pathOrHandle, bool bFollowLinks, bool bIsHandle)

This method is deprecated. It will be removed in a future version.

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.

Chilkat_9_5_0.CkDateTime GetFileLastAccessDt(string pathOrHandle, bool bFollowLinks, bool bIsHandle)

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 null on failure

Chilkat_9_5_0.Task GetFileLastAccessDtAsync(string pathOrHandle, bool bFollowLinks, bool bIsHandle)

Creates an asynchronous task to call the GetFileLastAccessDt method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns null on failure

How to Run an Asynchronous Task

How to Return an Object from an Async Task

string GetFileLastAccessStr(string pathOrHandle, bool bFollowLinks, bool bIsHandle)

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

Returns null on failure

Chilkat_9_5_0.Task GetFileLastAccessStrAsync(string pathOrHandle, bool bFollowLinks, bool bIsHandle)

Creates an asynchronous task to call the GetFileLastAccessStr method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns null on failure

How to Run an Asynchronous Task

Date GetFileLastModified(string pathOrHandle, bool bFollowLinks, bool bIsHandle)

This method is deprecated. It will be removed in a future version.

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.

Chilkat_9_5_0.CkDateTime GetFileLastModifiedDt(string pathOrHandle, bool bFollowLinks, bool bIsHandle)

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 null on failure

Chilkat_9_5_0.Task GetFileLastModifiedDtAsync(string pathOrHandle, bool bFollowLinks, bool bIsHandle)

Creates an asynchronous task to call the GetFileLastModifiedDt method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns null on failure

How to Run an Asynchronous Task

How to Return an Object from an Async Task

string GetFileLastModifiedStr(string pathOrHandle, bool bFollowLinks, bool bIsHandle)

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

Returns null on failure

Chilkat_9_5_0.Task GetFileLastModifiedStrAsync(string pathOrHandle, bool bFollowLinks, bool bIsHandle)

Creates an asynchronous task to call the GetFileLastModifiedStr method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns null on failure

How to Run an Asynchronous Task

string GetFileOwner(string pathOrHandle, bool bFollowLinks, bool bIsHandle)

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 null on failure

Chilkat_9_5_0.Task GetFileOwnerAsync(string pathOrHandle, bool bFollowLinks, bool bIsHandle)

Creates an asynchronous task to call the GetFileOwner method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns null on failure

How to Run an Asynchronous Task

int GetFilePermissions(string pathOrHandle, bool bFollowLinks, bool bIsHandle)

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.

Chilkat_9_5_0.Task GetFilePermissionsAsync(string pathOrHandle, bool bFollowLinks, bool bIsHandle)

Creates an asynchronous task to call the GetFilePermissions method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns null on failure

How to Run an Asynchronous Task

int GetFileSize32(string pathOrHandle, bool bFollowLinks, bool bIsHandle)

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.

string GetFileSizeStr(string pathOrHandle, bool bFollowLinks, bool bIsHandle)

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 null on failure

bool HardLink(string oldPath, string newPath)

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

Chilkat_9_5_0.Task HardLinkAsync(string oldPath, string newPath)

Introduced in version 9.5.0.71

Creates an asynchronous task to call the HardLink method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns null on failure

How to Run an Asynchronous Task

bool InitializeSftp()

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.

Chilkat_9_5_0.Task InitializeSftpAsync()

Creates an asynchronous task to call the InitializeSftp method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns null on failure

How to Run an Asynchronous Task

bool LastReadFailed(string handle)

Returns true if the last read on the specified handle failed. Otherwise returns false.

int LastReadNumBytes(string handle)

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

string OpenDir(string path)

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 null on failure

Understanding SFTP Absolute FilePaths

Chilkat_9_5_0.Task OpenDirAsync(string path)

Creates an asynchronous task to call the OpenDir method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns null on failure

How to Run an Asynchronous Task

string OpenFile(string remotePath, string access, string createDisposition)

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 null on failure

Understanding SFTP Absolute FilePaths

SFTP Where Did My Upload Go?

Change Remote Directory in SFTP

Chilkat_9_5_0.Task OpenFileAsync(string remotePath, string access, string createDisposition)

Creates an asynchronous task to call the OpenFile method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns null on failure

How to Run an Asynchronous Task

Chilkat_9_5_0.SFtpDir ReadDir(string handle)

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 null on failure

Chilkat_9_5_0.Task ReadDirAsync(string handle)

Creates an asynchronous task to call the ReadDir method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns null on failure

How to Run an Asynchronous Task

How to Return an Object from an Async Task

VARIANT ReadFileBytes(string handle, int numBytes)

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 null on failure

Chilkat_9_5_0.Task ReadFileBytesAsync(string handle, int numBytes)

Creates an asynchronous task to call the ReadFileBytes method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns null on failure

How to Run an Asynchronous Task

VARIANT ReadFileBytes32(string handle, int offset, int numBytes)

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 null on failure

VARIANT ReadFileBytes64s(string handle, string offset, int numBytes)

(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 null on failure

string ReadFileText(string handle, int numBytes, string charset)

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 null on failure

Chilkat_9_5_0.Task ReadFileTextAsync(string handle, int numBytes, string charset)

Creates an asynchronous task to call the ReadFileText method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns null on failure

How to Run an Asynchronous Task

string ReadFileText32(string handle, int offset, int numBytes, string charset)

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 null on failure

string ReadFileText64s(string handle, string offset, int numBytes, string charset)

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 null on failure

string ReadLink(string path)

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 null on failure

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

Chilkat_9_5_0.Task ReadLinkAsync(string path)

Introduced in version 9.5.0.71

Creates an asynchronous task to call the ReadLink method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns null on failure

How to Run an Asynchronous Task

string RealPath(string originalPath, string composePath)

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 null on failure

Chilkat_9_5_0.Task RealPathAsync(string originalPath, string composePath)

Creates an asynchronous task to call the RealPath method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns null on failure

How to Run an Asynchronous Task

bool RemoveDir(string path)

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.

Chilkat_9_5_0.Task RemoveDirAsync(string path)

Creates an asynchronous task to call the RemoveDir method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns null on failure

How to Run an Asynchronous Task

bool RemoveFile(string filename)

Deletes a file on the SFTP server.

Returns true for success, false for failure.

Understanding SFTP Absolute FilePaths

Chilkat_9_5_0.Task RemoveFileAsync(string filename)

Creates an asynchronous task to call the RemoveFile method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns null on failure

How to Run an Asynchronous Task

bool RenameFileOrDir(string oldPath, string newPath)

Renames a file or directory on the SFTP server.

Returns true for success, false for failure.

Chilkat_9_5_0.Task RenameFileOrDirAsync(string oldPath, string newPath)

Creates an asynchronous task to call the RenameFileOrDir method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns null on failure

How to Run an Asynchronous Task

bool ResumeDownloadFileByName(string remoteFilePath, string localFilePath)

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

Chilkat_9_5_0.Task ResumeDownloadFileByNameAsync(string remoteFilePath, string localFilePath)

Creates an asynchronous task to call the ResumeDownloadFileByName method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns null on failure

How to Run an Asynchronous Task

bool ResumeUploadFileByName(string remoteFilePath, string localFilePath)

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

Chilkat_9_5_0.Task ResumeUploadFileByNameAsync(string remoteFilePath, string localFilePath)

Creates an asynchronous task to call the ResumeUploadFileByName method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns null on failure

How to Run an Asynchronous Task

bool SendIgnore()

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.

Chilkat_9_5_0.Task SendIgnoreAsync()

Introduced in version 9.5.0.66

Creates an asynchronous task to call the SendIgnore method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns null on failure

How to Run an Asynchronous Task

bool SetCreateDt(string pathOrHandle, bool isHandle, Chilkat_9_5_0.CkDateTime createDateTime)

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.

Chilkat_9_5_0.Task SetCreateDtAsync(string pathOrHandle, bool isHandle, Chilkat_9_5_0.CkDateTime createDateTime)

Creates an asynchronous task to call the SetCreateDt method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns null on failure

How to Run an Asynchronous Task

bool SetCreateTime(string pathOrHandle, bool isHandle, Date createDateTime)

This method is deprecated. It will be removed in a future version.

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.

bool SetCreateTimeStr(string pathOrHandle, bool bIsHandle, string dateTimeStr)

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

Returns true for success, false for failure.

Chilkat_9_5_0.Task SetCreateTimeStrAsync(string pathOrHandle, bool bIsHandle, string dateTimeStr)

Creates an asynchronous task to call the SetCreateTimeStr method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns null on failure

How to Run an Asynchronous Task

bool SetLastAccessDt(string pathOrHandle, bool isHandle, Chilkat_9_5_0.CkDateTime accessDateTime)

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.

Chilkat_9_5_0.Task SetLastAccessDtAsync(string pathOrHandle, bool isHandle, Chilkat_9_5_0.CkDateTime accessDateTime)

Creates an asynchronous task to call the SetLastAccessDt method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns null on failure

How to Run an Asynchronous Task

bool SetLastAccessTime(string pathOrHandle, bool isHandle, Date accessDateTime)

This method is deprecated. It will be removed in a future version.

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.

bool SetLastAccessTimeStr(string pathOrHandle, bool bIsHandle, string dateTimeStr)

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

Returns true for success, false for failure.

Chilkat_9_5_0.Task SetLastAccessTimeStrAsync(string pathOrHandle, bool bIsHandle, string dateTimeStr)

Creates an asynchronous task to call the SetLastAccessTimeStr method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns null on failure

How to Run an Asynchronous Task

bool SetLastModifiedDt(string pathOrHandle, bool isHandle, Chilkat_9_5_0.CkDateTime modifiedDateTime)

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.

Chilkat_9_5_0.Task SetLastModifiedDtAsync(string pathOrHandle, bool isHandle, Chilkat_9_5_0.CkDateTime modifiedDateTime)

Creates an asynchronous task to call the SetLastModifiedDt method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns null on failure

How to Run an Asynchronous Task

bool SetLastModifiedTime(string pathOrHandle, bool isHandle, Date modifiedDateTime)

This method is deprecated. It will be removed in a future version.

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.

bool SetLastModifiedTimeStr(string pathOrHandle, bool bIsHandle, string dateTimeStr)

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

Returns true for success, false for failure.

Chilkat_9_5_0.Task SetLastModifiedTimeStrAsync(string pathOrHandle, bool bIsHandle, string dateTimeStr)

Creates an asynchronous task to call the SetLastModifiedTimeStr method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns null on failure

How to Run an Asynchronous Task

bool SetOwnerAndGroup(string pathOrHandle, bool isHandle, string owner, string group)

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.

Chilkat_9_5_0.Task SetOwnerAndGroupAsync(string pathOrHandle, bool isHandle, string owner, string group)

Creates an asynchronous task to call the SetOwnerAndGroup method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns null on failure

How to Run an Asynchronous Task

bool SetPermissions(string pathOrHandle, bool isHandle, int permissions)

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.

Chilkat_9_5_0.Task SetPermissionsAsync(string pathOrHandle, bool isHandle, int permissions)

Creates an asynchronous task to call the SetPermissions method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns null on failure

How to Run an Asynchronous Task

bool SymLink(string oldPath, string newPath)

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

Chilkat_9_5_0.Task SymLinkAsync(string oldPath, string newPath)

Introduced in version 9.5.0.71

Creates an asynchronous task to call the SymLink method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns null on failure

How to Run an Asynchronous Task

bool SyncTreeDownload(string remoteRoot, string localRoot, int mode, bool recurse)

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

Chilkat_9_5_0.Task SyncTreeDownloadAsync(string remoteRoot, string localRoot, int mode, bool recurse)

Creates an asynchronous task to call the SyncTreeDownload method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns null on failure

How to Run an Asynchronous Task

bool SyncTreeUpload(string localBaseDir, string remoteBaseDir, int mode, bool bRecurse)

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

Chilkat_9_5_0.Task SyncTreeUploadAsync(string localBaseDir, string remoteBaseDir, int mode, bool bRecurse)

Creates an asynchronous task to call the SyncTreeUpload method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns null on failure

How to Run an Asynchronous Task

bool UnlockComponent(string unlockCode)

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

bool UploadBd(Chilkat_9_5_0.BinData binData, string remoteFilePath)

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

Chilkat_9_5_0.Task UploadBdAsync(Chilkat_9_5_0.BinData binData, string remoteFilePath)

Introduced in version 9.5.0.62

Creates an asynchronous task to call the UploadBd method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns null on failure

How to Run an Asynchronous Task

bool UploadFile(string handle, string fromFilename)

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.

Chilkat_9_5_0.Task UploadFileAsync(string handle, string fromFilename)

Creates an asynchronous task to call the UploadFile method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns null on failure

How to Run an Asynchronous Task

bool UploadFileByName(string remoteFilePath, string localFilePath)

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

Chilkat_9_5_0.Task UploadFileByNameAsync(string remoteFilePath, string localFilePath)

Creates an asynchronous task to call the UploadFileByName method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns null on failure

How to Run an Asynchronous Task

bool UploadSb(Chilkat_9_5_0.StringBuilder sb, string remoteFilePath, string charset, bool includeBom)

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

Chilkat_9_5_0.Task UploadSbAsync(Chilkat_9_5_0.StringBuilder sb, string remoteFilePath, string charset, bool includeBom)

Introduced in version 9.5.0.62

Creates an asynchronous task to call the UploadSb method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns null on failure

How to Run an Asynchronous Task

bool WriteFileBytes(string handle, VARIANT byteData)

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.

Chilkat_9_5_0.Task WriteFileBytesAsync(string handle, VARIANT byteData)

Creates an asynchronous task to call the WriteFileBytes method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns null on failure

How to Run an Asynchronous Task

bool WriteFileBytes32(string handle, int offset, VARIANT data)

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.

bool WriteFileBytes64s(string handle, string offset64, VARIANT data)

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.

bool WriteFileText(string handle, string charset, string textData)

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.

Chilkat_9_5_0.Task WriteFileTextAsync(string handle, string charset, string textData)

Creates an asynchronous task to call the WriteFileText method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns null on failure

How to Run an Asynchronous Task

bool WriteFileText32(string handle, int offset32, string charset, string textData)

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.

bool WriteFileText64s(string handle, string offset64, string charset, string textData)

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.