Ftp2 Tcl Reference Documentation

Ftp2

Commercial File Transfer Protocol (FTP) Component.

Object Creation

set myFtp2 [new CkFtp2]

Properties

AbortCurrent (boolean 1/0)

set boolVal [CkFtp2_get_AbortCurrent $myFtp2]
CkFtp2_put_AbortCurrent $myFtp2 $boolVal

Introduced in version 9.5.0.58

When set to 1, 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 0 when the next method is called. When the abort occurs, this property is reset to 0. Both synchronous and asynchronous method calls can be aborted. (A synchronous method call could be aborted by setting this property from a separate thread.)

Account (string)

# ckStr is a CkString
CkFtp2_get_Account $myFtp2 $ckStr
set strVal [CkFtp2_get_account $myFtp2]
CkFtp2_put_Account $myFtp2 $strVal

Some FTP servers require an Account name in addition to login/password. This property can be set for those servers with this requirement.

ActivePortRangeEnd (integer)

set intVal [CkFtp2_get_ActivePortRangeEnd $myFtp2]
CkFtp2_put_ActivePortRangeEnd $myFtp2 $intVal

When Active (i.e. PORT) mode is used (opposite of Passive), the client-side is responsible for choosing a random port for each data connection. (Note: In the FTP protocol, each data transfer occurs on a separate TCP/IP connection. Commands are sent over the control channel (port 21 for non-SSL, port 990 for SSL).)

This property, along with ActivePortRangeStart, allows the client to specify a range of ports for data connections.

more information about FTP port ranges

ActivePortRangeStart (integer)

set intVal [CkFtp2_get_ActivePortRangeStart $myFtp2]
CkFtp2_put_ActivePortRangeStart $myFtp2 $intVal

This property, along with ActivePortRangeEnd, allows the client to specify a range of ports for data connections when in Active mode.

more information about FTP port ranges

AllocateSize (unsigned integer)

set intVal [CkFtp2_get_AllocateSize $myFtp2]
CkFtp2_put_AllocateSize $myFtp2 $intVal

If set to a non-zero value, causes an ALLO command, with this size as the parameter, to be automatically sent when uploading files to an FTP server.

This command could be required by some servers to reserve sufficient storage space to accommodate the new file to be transferred.

AllowMlsd (boolean 1/0)

set boolVal [CkFtp2_get_AllowMlsd $myFtp2]
CkFtp2_put_AllowMlsd $myFtp2 $boolVal

Introduced in version 9.5.0.50

If 1, then uses the MLSD command to fetch directory listings when the FTP server supports MLSD. This property is 1 by default.

When MLSD is used, the GetPermissions method will return the "perm fact" for a given file or directory. This is a different format than the more commonly recognized UNIX permissions string. Note: MLSD provides more accurate and dependable file listings, especially for last-mod date/time information. If usage of the MLSD command is turned off, it may adversely affect the quality and availability of other information.

Get FTP File Permissions

AsyncBytesReceived (unsigned integer)

set intVal [CkFtp2_get_AsyncBytesReceived $myFtp2]

The number of bytes received during an asynchronous FTP download. This property is updated in real-time and an application may periodically fetch and display it's value while the download is in progress.

AsyncBytesReceived64 (64-bit integer)

set int64Val [CkFtp2_get_AsyncBytesReceived64 $myFtp2]

Same as AsyncBytesReceived, but returns the value as a 64-bit integer.

AsyncBytesReceivedStr (string)

# ckStr is a CkString
CkFtp2_get_AsyncBytesReceivedStr $myFtp2 $ckStr
set strVal [CkFtp2_get_asyncBytesReceivedStr $myFtp2]

The number of bytes received during an asynchronous FTP download. This property is updated in real-time and an application may periodically fetch and display it's value while the download is in progress.

AsyncBytesSent (unsigned integer)

set intVal [CkFtp2_get_AsyncBytesSent $myFtp2]

The number of bytes sent during an asynchronous FTP upload. This property is updated in real-time and an application may periodically fetch and display it's value while the upload is in progress.

AsyncBytesSent64 (64-bit integer)

set int64Val [CkFtp2_get_AsyncBytesSent64 $myFtp2]

Same as AsyncBytesSent, but returns the value as a 64-bit integer.

AsyncBytesSentStr (string)

# ckStr is a CkString
CkFtp2_get_AsyncBytesSentStr $myFtp2 $ckStr
set strVal [CkFtp2_get_asyncBytesSentStr $myFtp2]

The number of bytes sent during an asynchronous FTP upload. This string property is updated in real-time and an application may periodically fetch and display it's value while the upload is in progress.

AsyncFinished (boolean 1/0)

set boolVal [CkFtp2_get_AsyncFinished $myFtp2]

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

Set to 1 if the asynchronous transfer (download or upload) is finished.

This functionality is replaced by the new model for asynchronous programming introduced in Chilkat v9.5.0.52. Applications should use the new model, which is identified by methods having names ending with "Async" and return a task object.

AsyncLog (string)

# ckStr is a CkString
CkFtp2_get_AsyncLog $myFtp2 $ckStr
set strVal [CkFtp2_get_asyncLog $myFtp2]

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

The last-error information for an asynchronous (background) file transfer.

This functionality is replaced by the new model for asynchronous programming introduced in Chilkat v9.5.0.52. Applications should use the new model, which is identified by methods having names ending with "Async" and return a task object.

AsyncPercentDone (unsigned integer)

set intVal [CkFtp2_get_AsyncPercentDone $myFtp2]

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

The current percentage completed of an asynchronous FTP upload or download. This property is updated in real-time and an application may periodically fetch and display it's value while the asynchronous data transfer is in progress.

This functionality is replaced by the new model for asynchronous programming introduced in Chilkat v9.5.0.52. Applications should use the new model, which is identified by methods having names ending with "Async" and return a task object.

AsyncSuccess (boolean 1/0)

set boolVal [CkFtp2_get_AsyncSuccess $myFtp2]

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

Set to 1 if the asynchronous file transfer succeeded.

This functionality is replaced by the new model for asynchronous programming introduced in Chilkat v9.5.0.52. Applications should use the new model, which is identified by methods having names ending with "Async" and return a task object.

AuthSsl (boolean 1/0)

set boolVal [CkFtp2_get_AuthSsl $myFtp2]
CkFtp2_put_AuthSsl $myFtp2 $boolVal

Same as AuthTls, except the command sent to the FTP server is "AUTH SSL" instead of "AUTH TLS". Most FTP servers accept either. AuthTls is more commonly used. If a particular server has trouble with AuthTls, try AuthSsl instead.

AuthTls (boolean 1/0)

set boolVal [CkFtp2_get_AuthTls $myFtp2]
CkFtp2_put_AuthTls $myFtp2 $boolVal

Set this to 1 to switch to a TLS 1.0 encrypted channel. This property should be set prior to connecting. If this property is set, the port typically remains at it's default (21) and the Ssl property should *not* be set. When AuthTls is used, all control and data transmissions are encrypted. If your FTP client is behind a network-address-translating router, you may need to call ClearControlChannel after connecting and authenticating (i.e. after calling the Connect method). This keeps all data transmissions encrypted, but clears the control channel so that commands are sent unencrypted, thus allowing the router to translate network IP numbers in FTP commands.

AutoFeat (boolean 1/0)

set boolVal [CkFtp2_get_AutoFeat $myFtp2]
CkFtp2_put_AutoFeat $myFtp2 $boolVal

When 1 (which is the default value), a "FEAT" command is automatically sent to the FTP server immediately after connecting. This allows the Chilkat FTP2 component to know more about the server's capabilities and automatically adjust any applicable internal settings based on the response. In rare cases, some FTP servers reject the "FEAT" command and close the connection. Usually, if an FTP server does not implement FEAT, a harmless "command not understood" response is returned.

Set this property to 0 to prevent the FEAT command from being sent.

AutoFix (boolean 1/0)

set boolVal [CkFtp2_get_AutoFix $myFtp2]
CkFtp2_put_AutoFix $myFtp2 $boolVal

If 1, then the following will occur when a connection is made to an FTP server:

1) If the Port property = 990, then sets AuthTls = 0, AuthSsl = 0, and Ssl = 1
2) If the Port property = 21, sets Ssl = 0

The default value of this property is 1.

AutoGetSizeForProgress (boolean 1/0)

set boolVal [CkFtp2_get_AutoGetSizeForProgress $myFtp2]
CkFtp2_put_AutoGetSizeForProgress $myFtp2 $boolVal

Forces the component to retrieve each file's size prior to downloading for the purpose of monitoring percentage completion progress. For many FTP servers, this is not required and therefore for performance reasons this property defaults to 0.

AutoOptsUtf8 (boolean 1/0)

set boolVal [CkFtp2_get_AutoOptsUtf8 $myFtp2]
CkFtp2_put_AutoOptsUtf8 $myFtp2 $boolVal

Introduced in version 9.5.0.47

When 1 (which is the default value), then an "OPTS UTF8 ON" command is automatically sent when connecting/authenticating if it is discovered via the FEAT command that the UTF8 option is supported.

Set this property to 0 to prevent the "OPTS UTF8 ON" command from being sent.

AutoSetUseEpsv (boolean 1/0)

set boolVal [CkFtp2_get_AutoSetUseEpsv $myFtp2]
CkFtp2_put_AutoSetUseEpsv $myFtp2 $boolVal

Introduced in version 9.5.0.44

If 1 then the UseEpsv property is automatically set upon connecting to the FTP server. The default value of this property is 0.

If the AutoFeat property is 1, and if the AutoSetUseEpsv property is 1, then the FTP server's features are automatically queried when connecting. In this case, the UseEpsv property is automatically set to 1 if the FTP server supports EPSV.

Important: EPSV can cause problems with some deep-inspection firewalls. If a passive data connection cannot be established, make sure to test with both the AutoSetUseEpsv and UseEpsv properties set equal to 0.

AutoSyst (boolean 1/0)

set boolVal [CkFtp2_get_AutoSyst $myFtp2]
CkFtp2_put_AutoSyst $myFtp2 $boolVal

When 1 (which is the default value), a "SYST" command is automatically sent to the FTP server immediately after connecting. This allows the Chilkat FTP2 component to know more about the server and automatically adjust any applicable internal settings based on the response. If the SYST command causes trouble (which is rare), this behavior can be turned off by setting this property equal to 0.

AutoXcrc (boolean 1/0)

set boolVal [CkFtp2_get_AutoXcrc $myFtp2]
CkFtp2_put_AutoXcrc $myFtp2 $boolVal

Many FTP servers support the XCRC command. The Chilkat FTP component will automatically know if XCRC is supported because it automatically sends a FEAT command to the server immediately after connecting.

If this property is set to 1, then all uploads will be automatically verified by sending an XCRC command immediately after the transfer completes. If the CRC is not verified, the upload method (such as PutFile) will return a failed status.

To prevent XCRC checking, set this property to 0.

BandwidthThrottleDown (integer)

set intVal [CkFtp2_get_BandwidthThrottleDown $myFtp2]
CkFtp2_put_BandwidthThrottleDown $myFtp2 $intVal

If set to a non-zero value, the FTP2 component will bandwidth throttle all downloads to this value.

The default value of this property is 0. The value should be specified in bytes/second.

Note: It is difficult to throttle very small downloads. (For example, how do you bandwidth throttle a 1-byte download???) As the downloaded file size gets larger, the transfer rate will better approximate this property's setting.

FTP Bandwidth Throttle for Downloads

BandwidthThrottleUp (integer)

set intVal [CkFtp2_get_BandwidthThrottleUp $myFtp2]
CkFtp2_put_BandwidthThrottleUp $myFtp2 $intVal

If set to a non-zero value, the FTP2 component will bandwidth throttle all uploads to this value.

The default value of this property is 0. The value should be specified in bytes/second.

Note: It is difficult to throttle very small uploads. (For example, how do you bandwidth throttle a 1-byte upload???) As the uploaded file size gets larger, the transfer rate will better approximate this property's setting.

FTP Bandwidth Throttle for Upload

ClientIpAddress (string)

# ckStr is a CkString
CkFtp2_get_ClientIpAddress $myFtp2 $ckStr
set strVal [CkFtp2_get_clientIpAddress $myFtp2]
CkFtp2_put_ClientIpAddress $myFtp2 $strVal

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

Important Bind to Adapter Notes for Windows

CommandCharset (string)

# ckStr is a CkString
CkFtp2_get_CommandCharset $myFtp2 $ckStr
set strVal [CkFtp2_get_commandCharset $myFtp2]
CkFtp2_put_CommandCharset $myFtp2 $strVal

Indicates the charset to be used for commands sent to the FTP server. The command charset must match what the FTP server is expecting in order to communicate non-English characters correctly. The default value of this property is "ansi".

This property may be updated to "utf-8" after connecting because a "FEAT" command is automatically sent to get the features of the FTP server. If UTF8 is indicated as a feature, then this property is automatically changed to "utf-8".

ConnectFailReason (integer)

set intVal [CkFtp2_get_ConnectFailReason $myFtp2]

If the Connect method fails, this property can be checked to determine the reason for failure.

Possible values are:

0 = success

Normal (non-TLS) sockets:
1 = empty hostname
2 = DNS lookup failed
3 = DNS timeout
4 = Aborted by application.
5 = Internal failure.
6 = Connect Timed Out
7 = Connect Rejected (or failed for some other reason)

SSL/TLS:
100 = TLS internal error.
101 = Failed to send client hello.
102 = Unexpected handshake message.
103 = Failed to read server hello.
104 = No server certificate.
105 = Unexpected TLS protocol version.
106 = Server certificate verify failed (the server certificate is expired or the cert's signature verification failed).
107 = Unacceptable TLS protocol version.
109 = Failed to read handshake messages.
110 = Failed to send client certificate handshake message.
111 = Failed to send client key exchange handshake message.
112 = Client certificate's private key not accessible.
113 = Failed to send client cert verify handshake message.
114 = Failed to send change cipher spec handshake message.
115 = Failed to send finished handshake message.
116 = Server's Finished message is invalid.

FTP:
200 = Connected, but failed to receive greeting from FTP server.
201 = Failed to do AUTH TLS or AUTH SSL.
Protocol/Component:
300 = asynch op in progress
301 = login failure.

ConnectTimeout (integer)

set intVal [CkFtp2_get_ConnectTimeout $myFtp2]
CkFtp2_put_ConnectTimeout $myFtp2 $intVal

Maximum number of seconds to wait when connecting to an FTP server. The default is 30 seconds. A value of 0 indicates the willingness to wait forever.

ConnectVerified (boolean 1/0)

set boolVal [CkFtp2_get_ConnectVerified $myFtp2]

True if the FTP2 component was able to establish a TCP/IP connection to the FTP server after calling Connect.

CrlfMode (integer)

set intVal [CkFtp2_get_CrlfMode $myFtp2]
CkFtp2_put_CrlfMode $myFtp2 $intVal

Used to control CRLF line endings when downloading text files in ASCII mode. The default value is 0.

Possible values are:

0 = Do nothing.  The line-endings are not modified as received from the FTP server.
1 = Convert all line-endings to CR+LF
2 = Convert all line-endings to bare LF's
3 = Convert all line-endings to bare CR's

DataProtection (string)

# ckStr is a CkString
CkFtp2_get_DataProtection $myFtp2 $ckStr
set strVal [CkFtp2_get_dataProtection $myFtp2]
CkFtp2_put_DataProtection $myFtp2 $strVal

Introduced in version 9.5.0.52

Controls the data protection level for the data connections. Possible values are "control", "clear", or "private".

  • "control" is the default, and the data connections will be the same as for the control connection. If the control connection is SSL/TLS, then the data connections are also SSL/TLS. If the control connection is unencrypted, then the data connections will also be unencrypted.
  • "clear" means that the data connections will always be unencrypted.
  • "private" means that the data connections will always be encrypted.

DebugLogFilePath (string)

# ckStr is a CkString
CkFtp2_get_DebugLogFilePath $myFtp2 $ckStr
set strVal [CkFtp2_get_debugLogFilePath $myFtp2]
CkFtp2_put_DebugLogFilePath $myFtp2 $strVal

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.

DirListingCharset (string)

# ckStr is a CkString
CkFtp2_get_DirListingCharset $myFtp2 $ckStr
set strVal [CkFtp2_get_dirListingCharset $myFtp2]
CkFtp2_put_DirListingCharset $myFtp2 $strVal

Indicates the charset of the directory listings received from the FTP server. The FTP2 client must interpret the directory listing bytes using the correct character encoding in order to correctly receive non-English characters. The default value of this property is "ansi".

This property may be updated to "utf-8" after connecting because a "FEAT" command is automatically sent to get the features of the FTP server. If UTF8 is indicated as a feature, then this property is automatically changed to "utf-8".

Charsets Supported by Chilkat

DownloadTransferRate (integer)

set intVal [CkFtp2_get_DownloadTransferRate $myFtp2]

The average download rate in bytes/second. This property is updated in real-time during any FTP download (asynchronous or synchronous).

ForcePortIpAddress (string)

# ckStr is a CkString
CkFtp2_get_ForcePortIpAddress $myFtp2 $ckStr
set strVal [CkFtp2_get_forcePortIpAddress $myFtp2]
CkFtp2_put_ForcePortIpAddress $myFtp2 $strVal

If set, forces the IP address used in the PORT command for Active mode (i.e. non-passive) data transfers. This string property should be set to the IP address in dotted notation, such as "233.190.65.31".

Note: This property can also be set to the special keyword "control" to force the PORT IP address to be the address of the control connection's peer.

Starting in v9.5.0.58, the IP address can be prefixed with the string "bind-". For example, "bind-233.190.65.31". When "bind-" is specified, the local data socket will be bound to the IP address when created. Otherwise, the IP address is only used as the argument to the PORT command that is sent to the server.

Greeting (string)

# ckStr is a CkString
CkFtp2_get_Greeting $myFtp2 $ckStr
set strVal [CkFtp2_get_greeting $myFtp2]

The initial greeting received from the FTP server after connecting.

HasModeZ (boolean 1/0)

set boolVal [CkFtp2_get_HasModeZ $myFtp2]

Chilkat FTP2 supports MODE Z, which is a transfer mode implemented by some FTP servers. It allows for files to be uploaded and downloaded using compressed streams (using the zlib deflate algorithm). This is a read-only property. It will be set to 1 if the FTP2 component detects that your FTP server supports MODE Z. Otherwise it is set to 0.

Hostname (string)

# ckStr is a CkString
CkFtp2_get_Hostname $myFtp2 $ckStr
set strVal [CkFtp2_get_hostname $myFtp2]
CkFtp2_put_Hostname $myFtp2 $strVal

The domain name of the FTP server. May also use the IPv4 or IPv6 address in string format.

HttpProxyAuthMethod (string)

# ckStr is a CkString
CkFtp2_get_HttpProxyAuthMethod $myFtp2 $ckStr
set strVal [CkFtp2_get_httpProxyAuthMethod $myFtp2]
CkFtp2_put_HttpProxyAuthMethod $myFtp2 $strVal

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 (string)

# ckStr is a CkString
CkFtp2_get_HttpProxyDomain $myFtp2 $ckStr
set strVal [CkFtp2_get_httpProxyDomain $myFtp2]
CkFtp2_put_HttpProxyDomain $myFtp2 $strVal

If an HTTP proxy is used, and it uses NTLM authentication, then this optional property is the NTLM authentication domain.

HttpProxyHostname (string)

# ckStr is a CkString
CkFtp2_get_HttpProxyHostname $myFtp2 $ckStr
set strVal [CkFtp2_get_httpProxyHostname $myFtp2]
CkFtp2_put_HttpProxyHostname $myFtp2 $strVal

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

FTP over HTTP Proxy

HttpProxyPassword (string)

# ckStr is a CkString
CkFtp2_get_HttpProxyPassword $myFtp2 $ckStr
set strVal [CkFtp2_get_httpProxyPassword $myFtp2]
CkFtp2_put_HttpProxyPassword $myFtp2 $strVal

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

HttpProxyPort (integer)

set intVal [CkFtp2_get_HttpProxyPort $myFtp2]
CkFtp2_put_HttpProxyPort $myFtp2 $intVal

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 (string)

# ckStr is a CkString
CkFtp2_get_HttpProxyUsername $myFtp2 $ckStr
set strVal [CkFtp2_get_httpProxyUsername $myFtp2]
CkFtp2_put_HttpProxyUsername $myFtp2 $strVal

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

FTP over HTTP Proxy

IdleTimeoutMs (integer)

set intVal [CkFtp2_get_IdleTimeoutMs $myFtp2]
CkFtp2_put_IdleTimeoutMs $myFtp2 $intVal

Forces a timeout when a response is expected on the control channel, but no response arrives for this number of milliseconds. Setting IdleTimeoutMs = 0 allows the application to wait indefinitely. The default value is 60000 (i.e. 60 seconds).

IsConnected (boolean 1/0)

set boolVal [CkFtp2_get_IsConnected $myFtp2]

Important: This property is deprecated. Applications should instead call the CheckConnection method.

Returns 1 if currently connected and logged into an FTP server, otherwise returns 0.

Note: Accessing this property may cause a NOOP command to be sent to the FTP server.

KeepSessionLog (boolean 1/0)

set boolVal [CkFtp2_get_KeepSessionLog $myFtp2]
CkFtp2_put_KeepSessionLog $myFtp2 $boolVal

Turns the in-memory session logging on or off. If on, the session log can be obtained via the SessionLog property.

LargeFileMeasures (boolean 1/0)

set boolVal [CkFtp2_get_LargeFileMeasures $myFtp2]
CkFtp2_put_LargeFileMeasures $myFtp2 $boolVal

Introduced in version 9.5.0.66

Enables internal features that can help when downloading extremely large files. In some cases, if the time required to download a file is long, the control connection is closed by the server or other network infrastructure because it was idle for so long. Setting this property equal to 1 will keep the control connection very slightly used to prevent this from happening.

The default value of this property is 0. This property should only be set to 1 if this sort of problem is encountered.

LastErrorHtml (string)

# ckStr is a CkString
CkFtp2_get_LastErrorHtml $myFtp2 $ckStr
set strVal [CkFtp2_get_lastErrorHtml $myFtp2]

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 (string)

# ckStr is a CkString
CkFtp2_get_LastErrorText $myFtp2 $ckStr
set strVal [CkFtp2_get_lastErrorText $myFtp2]

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 (string)

# ckStr is a CkString
CkFtp2_get_LastErrorXml $myFtp2 $ckStr
set strVal [CkFtp2_get_lastErrorXml $myFtp2]

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 (boolean 1/0)

set boolVal [CkFtp2_get_LastMethodSuccess $myFtp2]
CkFtp2_put_LastMethodSuccess $myFtp2 $boolVal

Introduced in version 9.5.0.52

Indicate whether the last method call succeeded or failed. A value of 1 indicates success, a value of 0 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 = 1 and failure = 0.
  • 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 1. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

LastReply (string)

# ckStr is a CkString
CkFtp2_get_LastReply $myFtp2 $ckStr
set strVal [CkFtp2_get_lastReply $myFtp2]

Contains the last control-channel reply. For example: "550 Failed to change directory." or "250 Directory successfully changed." The control channel reply is typically formatted as an integer status code followed by a one-line description.

ListPattern (string)

# ckStr is a CkString
CkFtp2_get_ListPattern $myFtp2 $ckStr
set strVal [CkFtp2_get_listPattern $myFtp2]
CkFtp2_put_ListPattern $myFtp2 $strVal

A wildcard pattern, defaulting to "*" that determines the files and directories included in the following properties and methods: GetDirCount, NumFilesAndDirs, GetCreateTime, GetFilename, GetIsDirectory, GetLastAccessTime, GetModifiedTime, GetSize.

Note: Do not include a directory path in the ListPattern. For example, do not set the ListPattern equal to a string such as this: "subdir/*.txt". The correct solution is to first change the remote directory to "subdir" by calling ChangeRemoteDir, and then set the ListPattern equal to "*.txt".

How ListPattern can affect the Quality of Directory Information

LoginVerified (boolean 1/0)

set boolVal [CkFtp2_get_LoginVerified $myFtp2]

True if the FTP2 component was able to login to the FTP server after calling Connect.

NumFilesAndDirs (integer)

set intVal [CkFtp2_get_NumFilesAndDirs $myFtp2]

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

Important: This property is deprecated. Applications should instead call the GetDirCount method.

The number of files and sub-directories in the current remote directory that match the ListPattern. (The ListPattern defaults to "*", so unless changed, this is the total number of files and sub-directories.)

Important: Accessing this property can cause the directory listing to be retrieved from the FTP server. For FTP servers that doe not support the MLST/MLSD commands, this is technically a data transfer that requires a temporary data connection to be established in the same way as when uploading or downloading files. If your program hangs while accessing NumFilesAndDirs, it probably means that the data connection could not be established. The most common solution is to switch to using Passive mode by setting the Passive property = 1. If this does not help, examine the contents of the LastErrorText property after NumFilesAndDirs finally returns (after timing out). Also, see this Chilkat blog post about FTP connection settings.

Special considerations.

PartialTransfer (boolean 1/0)

set boolVal [CkFtp2_get_PartialTransfer $myFtp2]

A read-only property that indicates whether a partial transfer was received in the last method call to download a file. Set to 1 if a partial transfer was received. Set to 0 if nothing was received, or if the full file was received.

Passive (boolean 1/0)

set boolVal [CkFtp2_get_Passive $myFtp2]
CkFtp2_put_Passive $myFtp2 $boolVal

Set to 1 for FTP to operate in passive mode, otherwise set to 0 for non-passive (.i.e. "active" or "port" mode). The default value of this property is 1.

Passive vs. Active Mode Explained

Determining FTP2 Connection Settings

PassiveUseHostAddr (boolean 1/0)

set boolVal [CkFtp2_get_PassiveUseHostAddr $myFtp2]
CkFtp2_put_PassiveUseHostAddr $myFtp2 $boolVal

This can handle problems that may arise when an FTP server is located behind a NAT router. FTP servers respond to the PASV command by sending the IP address and port where it will be listening for the data connection. If the control connection is SSL encrypted, the NAT router is not able to convert from an internal IP address (typically beginning with 192.168) to an external address. When set to 1, PassiveUseHostAddr property tells the FTP client to discard the IP address part of the PASV response and replace it with the IP address of the already-established control connection. The default value of this property is 0.

Password (string)

# ckStr is a CkString
CkFtp2_get_Password $myFtp2 $ckStr
set strVal [CkFtp2_get_password $myFtp2]
CkFtp2_put_Password $myFtp2 $strVal

Password for logging into the FTP server.

Port (integer)

set intVal [CkFtp2_get_Port $myFtp2]
CkFtp2_put_Port $myFtp2 $intVal

Port number. Automatically defaults to the default port for the FTP service.

PreferIpv6 (boolean 1/0)

set boolVal [CkFtp2_get_PreferIpv6 $myFtp2]
CkFtp2_put_PreferIpv6 $myFtp2 $boolVal

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

PreferNlst (boolean 1/0)

set boolVal [CkFtp2_get_PreferNlst $myFtp2]
CkFtp2_put_PreferNlst $myFtp2 $boolVal

If 1, the NLST command is used instead of LIST when fetching a directory listing. This can help in very rare cases where the FTP server returns truncated filenames. The drawback to using NLST is that it won't return size or date/time info (but it should return the full filename).

The default value of this property is 0.

ProgressMonSize (integer)

set intVal [CkFtp2_get_ProgressMonSize $myFtp2]
CkFtp2_put_ProgressMonSize $myFtp2 $intVal

Progress monitoring for FTP downloads rely on the FTP server indicating the file size within the RETR response. Some FTP servers however, do not indicate the file size and therefore it is not possible to monitor progress based on percentage completion. This property allows the application to explicitly tell the FTP component the size of the file about to be downloaded for the next GetFile call.

ProgressMonSize (more info and example)

ProgressMonSize64 (64-bit integer)

set int64Val [CkFtp2_get_ProgressMonSize64 $myFtp2]
CkFtp2_put_ProgressMonSize64 $myFtp2 $int64Val

Same as ProgressMonSize, but allows for sizes greater than the 32-bit integer limit.

ProxyHostname (string)

# ckStr is a CkString
CkFtp2_get_ProxyHostname $myFtp2 $ckStr
set strVal [CkFtp2_get_proxyHostname $myFtp2]
CkFtp2_put_ProxyHostname $myFtp2 $strVal

The hostname of your FTP proxy, if a proxy server is used.

ProxyMethod (integer)

set intVal [CkFtp2_get_ProxyMethod $myFtp2]
CkFtp2_put_ProxyMethod $myFtp2 $intVal

The proxy scheme used by your FTP proxy server. Valid values are 0 to 9. The default value is 0 which indicates that no proxy server is used. Supported proxy methods are as follows:

Note: The ProxyHostname is the hostname of the firewall, if the proxy is a firewall. Also, the ProxyUsername and ProxyPassword are the firewall username/password (if the proxy is a firewall).

ProxyMethod = 1 (SITE site)

USER ProxyUsername
PASS ProxyPassword
SITE Hostname
USER Username
PASS Password

ProxyMethod = 2 (USER user@site)

USER Username@Hostname:Port
PASS Password

ProxyMethod = 3 (USER with login)

USER ProxyUsername
PASS ProxyPassword
USER Username@Hostname:Port
PASS Password

ProxyMethod = 4 (USER/PASS/ACCT)

USER Username@Hostname:Port ProxyUsername
PASS Password
ACCT ProxyPassword

ProxyMethod = 5 (OPEN site)

USER ProxyUsername
PASS ProxyPassword
OPEN Hostname
USER Username
PASS Password

ProxyMethod = 6 (firewallId@site)

USER ProxyUsername@Hostname
USER Username
PASS Password

ProxyMethod = 7

USER ProxyUsername
USER ProxyPassword
SITE Hostname:Port USER Username
PASS Password

ProxyMethod = 8

USER Username@ProxyUsername@Hostname
PASS Password@ProxyPassword

ProxyMethod = 9

ProxyUsername ProxyPassword Username Password

ProxyPassword (string)

# ckStr is a CkString
CkFtp2_get_ProxyPassword $myFtp2 $ckStr
set strVal [CkFtp2_get_proxyPassword $myFtp2]
CkFtp2_put_ProxyPassword $myFtp2 $strVal

The password for authenticating with the FTP proxy server.

ProxyPort (integer)

set intVal [CkFtp2_get_ProxyPort $myFtp2]
CkFtp2_put_ProxyPort $myFtp2 $intVal

If an FTP proxy server is used, this is the port number at which the proxy server is listening for connections.

ProxyUsername (string)

# ckStr is a CkString
CkFtp2_get_ProxyUsername $myFtp2 $ckStr
set strVal [CkFtp2_get_proxyUsername $myFtp2]
CkFtp2_put_ProxyUsername $myFtp2 $strVal

The username for authenticating with the FTP proxy server.

ReadTimeout (integer)

set intVal [CkFtp2_get_ReadTimeout $myFtp2]
CkFtp2_put_ReadTimeout $myFtp2 $intVal

Forces a timeout when incoming data is expected on a data channel, but no data arrives for this number of seconds. The ReadTimeout is the amount of time that needs to elapse while no additional data is forthcoming. During a long download, if the data stream halts for more than this amount, it will timeout. Otherwise, there is no limit on the length of time for the entire download.

The default value is 60.

RequireSslCertVerify (boolean 1/0)

set boolVal [CkFtp2_get_RequireSslCertVerify $myFtp2]
CkFtp2_put_RequireSslCertVerify $myFtp2 $boolVal

If 1, then the FTP2 client will verify the server's SSL certificate. The server's certificate signature is verified with its issuer, and the issuer's cert is verified with its issuer, etc. up to the root CA cert. If a signature verification fails, the connection is not allowed. Also, if the certificate is expired, or if the cert's signature is invalid, the connection is not allowed. The default value of this property is 0.

RestartNext (boolean 1/0)

set boolVal [CkFtp2_get_RestartNext $myFtp2]
CkFtp2_put_RestartNext $myFtp2 $boolVal

Both uploads and downloads may be resumed by simply setting this property = 1 and re-calling the upload or download method.

Example: Restart/Resume FTP Download

Example: Restart/Resume FTP Upload

SendBufferSize (integer)

set intVal [CkFtp2_get_SendBufferSize $myFtp2]
CkFtp2_put_SendBufferSize $myFtp2 $intVal

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

This property is now deprecated, and has no effect in Chilkat versions 9.5.0.69 and greater.

In the past, it affected how often percent completion callbacks were made. Setting it to a smaller value caused more frequent percentage completion event callbacks. The default value is 65536 (64K) and should generally not be changed.

SessionLog (string)

# ckStr is a CkString
CkFtp2_get_SessionLog $myFtp2 $ckStr
set strVal [CkFtp2_get_sessionLog $myFtp2]

Contains the session log if KeepSessionLog is turned on.

SkipFinalReply (boolean 1/0)

set boolVal [CkFtp2_get_SkipFinalReply $myFtp2]
CkFtp2_put_SkipFinalReply $myFtp2 $boolVal

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

This property is deprecated and has no effect.

SocksHostname (string)

# ckStr is a CkString
CkFtp2_get_SocksHostname $myFtp2 $ckStr
set strVal [CkFtp2_get_socksHostname $myFtp2]
CkFtp2_put_SocksHostname $myFtp2 $strVal

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

FTP through SSH Tunnel

SocksPassword (string)

# ckStr is a CkString
CkFtp2_get_SocksPassword $myFtp2 $ckStr
set strVal [CkFtp2_get_socksPassword $myFtp2]
CkFtp2_put_SocksPassword $myFtp2 $strVal

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

SocksPort (integer)

set intVal [CkFtp2_get_SocksPort $myFtp2]
CkFtp2_put_SocksPort $myFtp2 $intVal

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 (string)

# ckStr is a CkString
CkFtp2_get_SocksUsername $myFtp2 $ckStr
set strVal [CkFtp2_get_socksUsername $myFtp2]
CkFtp2_put_SocksUsername $myFtp2 $strVal

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

SocksVersion (integer)

set intVal [CkFtp2_get_SocksVersion $myFtp2]
CkFtp2_put_SocksVersion $myFtp2 $intVal

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 (integer)

set intVal [CkFtp2_get_SoRcvBuf $myFtp2]
CkFtp2_put_SoRcvBuf $myFtp2 $intVal

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.

Note: This property only applies to FTP data connections. The FTP control connection is not used for uploading or downloading files, and is therefore not performance sensitive.

More Information about TCP performance and Buffer Sizes

SoSndBuf (integer)

set intVal [CkFtp2_get_SoSndBuf $myFtp2]
CkFtp2_put_SoSndBuf $myFtp2 $intVal

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.

Note: This property only applies to FTP data connections. The FTP control connection is not used for uploading or downloading files, and is therefore not performance sensitive.

More Information about TCP performance and Buffer Sizes

Ssl (boolean 1/0)

set boolVal [CkFtp2_get_Ssl $myFtp2]
CkFtp2_put_Ssl $myFtp2 $boolVal

Use TLS/SSL for FTP connections. You would typically set Ssl = 1 when connecting to port 990 on FTP servers that support TLS/SSL mode. Note: It is more common to use AuthTls.

SslAllowedCiphers (string)

# ckStr is a CkString
CkFtp2_get_SslAllowedCiphers $myFtp2 $ckStr
set strVal [CkFtp2_get_sslAllowedCiphers $myFtp2]
CkFtp2_put_SslAllowedCiphers $myFtp2 $strVal

Introduced in version 9.5.0.48

Provides a means for setting a list of ciphers that are allowed for SSL/TLS connections. The default (empty string) indicates that all implemented ciphers are possible. The TLS ciphers supported in Chilkat v9.5.0.55 and later are:

TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
TLS_DHE_RSA_WITH_AES_256_CBC_SHA
TLS_RSA_WITH_AES_256_CBC_SHA256
TLS_RSA_WITH_AES_256_GCM_SHA384
TLS_RSA_WITH_AES_256_CBC_SHA
TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
TLS_DHE_RSA_WITH_AES_128_CBC_SHA
TLS_RSA_WITH_AES_128_CBC_SHA256
TLS_RSA_WITH_AES_128_GCM_SHA256
TLS_RSA_WITH_AES_128_CBC_SHA
TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA
TLS_RSA_WITH_3DES_EDE_CBC_SHA
TLS_ECDHE_RSA_WITH_RC4_128_SHA
TLS_RSA_WITH_RC4_128_SHA
TLS_RSA_WITH_RC4_128_MD5
TLS_DHE_RSA_WITH_DES_CBC_SHA
TLS_RSA_WITH_DES_CBC_SHA
To restrict SSL/TLS connections to one or more specific ciphers, set this property to a comma-separated list of ciphers such as "TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384, TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384". The order should be in terms of preference, with the preferred algorithms listed first. (Note that the client cannot specifically choose the algorithm is picked because it is the server that chooses. The client simply provides the server with a list from which to choose.)

The property can also disallow connections with servers having certificates with RSA keys less than a certain size. By default, server certificates having RSA keys of 512 bits or greater are allowed. Add the keyword "rsa1024" to disallow connections with servers having keys smaller than 1024 bits. Add the keyword "rsa2048" to disallow connections with servers having keys smaller than 2048 bits.

Note: Prior to Chilkat v9.5.0.55, it was not possible to explicitly list allowed cipher suites. The deprecated means for indicating allowed ciphers was both incomplete and unprecise. For example, the following keywords could be listed to allow matching ciphers: "aes256-cbc", "aes128-cbc", "3des-cbc", and "rc4". These keywords will still be recognized, but programs should be updated to explicitly list the allowed ciphers.

secure-renegotiation: Starting in Chilkat v9.5.0.55, the keyword "secure-renegotiation" may be added to require that all renegotions be done securely (as per RFC 5746).

best-practices: Starting in Chilkat v9.5.0.55, this property may be set to the single keyword "best-practices". This will allow ciphers based on the current best practices. As new versions of Chilkat are released, the best practices may change. Changes will be noted here. The current best practices are:

  • If the server uses an RSA key, it must be 1024 bits or greater.
  • All renegotations must be secure renegotiations.
  • All ciphers using RC4, DES, or 3DES are disallowed.

Example: The following string would restrict to 2 specific cipher suites, require RSA keys to be 1024 bits or greater, and require secure renegotiations: "TLS_DHE_RSA_WITH_AES_256_CBC_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA, rsa1024, secure-renegotiation"

SslProtocol (string)

# ckStr is a CkString
CkFtp2_get_SslProtocol $myFtp2 $ckStr
set strVal [CkFtp2_get_sslProtocol $myFtp2]
CkFtp2_put_SslProtocol $myFtp2 $strVal

Selects the secure protocol to be used for secure (SSL/TLS) implicit and explicit (AUTH TLS / AUTH SSL) connections . Possible values are:

default
TLS 1.2
TLS 1.1
TLS 1.0
SSL 3.0
TLS 1.2 or higher
TLS 1.1 or higher
TLS 1.0 or higher
The default value is "default" which will choose the, which allows for the protocol to be selected dynamically at runtime based on the requirements of the server. Choosing an exact protocol will cause the connection to fail unless that exact protocol is negotiated. It is better to choose "X or higher" than an exact protocol. The "default" is effectively "SSL 3.0 or higher".

SslServerCertVerified (boolean 1/0)

set boolVal [CkFtp2_get_SslServerCertVerified $myFtp2]

Read-only property that returns 1 if the FTP server's digital certificate was verified when connecting via SSL / TLS.

SyncedFiles (string)

# ckStr is a CkString
CkFtp2_get_SyncedFiles $myFtp2 $ckStr
set strVal [CkFtp2_get_syncedFiles $myFtp2]
CkFtp2_put_SyncedFiles $myFtp2 $strVal

Introduced in version 9.5.0.51

The paths of the files uploaded or downloaded in the last call to SyncDeleteTree, SyncLocalDir, SyncLocalTree, SyncRemoteTree, or SyncRemoteTree2. 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 (string)

# ckStr is a CkString
CkFtp2_get_SyncMustMatch $myFtp2 $ckStr
set strVal [CkFtp2_get_syncMustMatch $myFtp2]
CkFtp2_put_SyncMustMatch $myFtp2 $strVal

Can contain a wildcarded list of file patterns separated by semicolons. For example, "*.xml; *.txt; *.csv". If set, the Sync* upload and download methods will only transfer files that match any one of these patterns. Pattern matching is case-insensitive.

Note: Starting in version 9.5.0.47, this property also applies to the DownloadTree and DirTreeXml methods.

SyncMustNotMatch (string)

# ckStr is a CkString
CkFtp2_get_SyncMustNotMatch $myFtp2 $ckStr
set strVal [CkFtp2_get_syncMustNotMatch $myFtp2]
CkFtp2_put_SyncMustNotMatch $myFtp2 $strVal

Can contain a wildcarded list of file patterns separated by semicolons. For example, "*.xml; *.txt; *.csv". If set, the Sync* upload and download methods will not transfer files that match any one of these patterns. Pattern matching is case-insensitive.

Note: Starting in version 9.5.0.47, this property also applies to the DownloadTree and DirTreeXml methods.

SyncPreview (string)

# ckStr is a CkString
CkFtp2_get_SyncPreview $myFtp2 $ckStr
set strVal [CkFtp2_get_syncPreview $myFtp2]

Contains the list of files that would be transferred in a call to SyncRemoteTree2 when the previewOnly argument is set to 1. This string property contains one filepath per line, separated by CRLF line endings. After SyncRemoteTree2 is called, this property contains the filepaths of the local files that would be uploaded to the FTP server.

Delete Local Files that Do Not Exist on the FTP Server

TlsCipherSuite (string)

# ckStr is a CkString
CkFtp2_get_TlsCipherSuite $myFtp2 $ckStr
set strVal [CkFtp2_get_tlsCipherSuite $myFtp2]

Introduced in version 9.5.0.49

Contains the current or last negotiated TLS cipher suite. If no TLS connection has yet to be established, or if a connection as attempted and failed, then this will be empty. A sample cipher suite string looks like this: TLS_DHE_RSA_WITH_AES_256_CBC_SHA256.

TlsPinSet (string)

# ckStr is a CkString
CkFtp2_get_TlsPinSet $myFtp2 $ckStr
set strVal [CkFtp2_get_tlsPinSet $myFtp2]
CkFtp2_put_TlsPinSet $myFtp2 $strVal

Introduced in version 9.5.0.55

Specifies a set of pins for Public Key Pinning for TLS connections. This property lists the expected SPKI fingerprints for the server certificates. If the server's certificate (sent during the TLS handshake) does not match any of the SPKI fingerprints, then the TLS handshake is aborted and the connection fails. The format of this string property is as follows:

hash_algorithm, encoding, SPKI_fingerprint_1, SPKI_fingerprint_2, ...
For example, the following string specifies a single sha256 base64-encoded SPKI fingerprint:
"sha256, base64, lKg1SIqyhPSK19tlPbjl8s02yChsVTDklQpkMCHvsTE="
This example specifies two SPKI fingerprints:
"sha256, base64, 4t37LpnGmrMEAG8HEz9yIrnvJV2euVRwCLb9EH5WZyI=, 68b0G5iqMvWVWvUCjMuhLEyekM5729PadtnU5tdXZKs="
Any of the following hash algorithms are allowed:.sha1, sha256, sha384, sha512, md2, md5, haval, ripemd128, ripemd160,ripemd256, or ripemd320.

The following encodings are allowed: base64, hex, and any of the encodings indicated in the link below.

Encodings Supported by Chilkat

TlsVersion (string)

# ckStr is a CkString
CkFtp2_get_TlsVersion $myFtp2 $ckStr
set strVal [CkFtp2_get_tlsVersion $myFtp2]

Introduced in version 9.5.0.49

Contains the current or last negotiated TLS protocol version. If no TLS connection has yet to be established, or if a connection as attempted and failed, then this will be empty. Possible values are "SSL 3.0", "TLS 1.0", "TLS 1.1", and "TLS 1.2".

UploadTransferRate (integer)

set intVal [CkFtp2_get_UploadTransferRate $myFtp2]

The average upload rate in bytes/second. This property is updated in real-time during any FTP upload (asynchronous or synchronous).

UseEpsv (boolean 1/0)

set boolVal [CkFtp2_get_UseEpsv $myFtp2]
CkFtp2_put_UseEpsv $myFtp2 $boolVal

If 1, the FTP2 component will use the EPSV command instead of PASV for passive mode data transfers. The default value of this property is 0. (It is somewhat uncommon for FTP servers to support EPSV.)

Note: If the AutoFeat property is 1, then the FTP server's features are automatically queried after connecting. In this case, if the AutoSetUseEpsv property is also set to 1, the UseEpsv property is automatically set to 1 if the FTP server supports EPSV.

Important: EPSV can cause problems with some deep-inspection firewalls. If a passive data connection cannot be established, make sure to test with both the AutoSetUseEpsv and UseEpsv properties set equal to 0.

EPSV Problems with some Firewalls

Username (string)

# ckStr is a CkString
CkFtp2_get_Username $myFtp2 $ckStr
set strVal [CkFtp2_get_username $myFtp2]
CkFtp2_put_Username $myFtp2 $strVal

Username for logging into the FTP server. Defaults to "anonymous".

Utf8 (boolean 1/0)

set boolVal [CkFtp2_get_Utf8 $myFtp2]
CkFtp2_put_Utf8 $myFtp2 $boolVal

When set to 1, all "const char *" arguments are interpreted as utf-8 strings. If set to 0 (the default), then "const char *" arguments are interpreted as ANSI strings. Also, when set to 1, and Chilkat method returning a "const char *" is returning the utf-8 representation. If set to 0, all "const char *" return values are ANSI strings.

VerboseLogging (boolean 1/0)

set boolVal [CkFtp2_get_VerboseLogging $myFtp2]
CkFtp2_put_VerboseLogging $myFtp2 $boolVal

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

Version (string)

# ckStr is a CkString
CkFtp2_get_Version $myFtp2 $ckStr
set strVal [CkFtp2_get_version $myFtp2]

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

Methods

# localFilePath is a string
# remoteFilePath is a string
set status [CkFtp2_AppendFile $localFilePath $remoteFilePath]

Same as PutFile but the file on the FTP server is appended.

If the remoteFilePath contains non-English characters, it may be necessary to set the DirListingCharset property equal to "utf-8". Please refer to the documentation for the DirListingCharset property.

Returns 1 for success, 0 for failure.

# returns a CkTask
# localFilePath is a string
# remoteFilePath is a string
set ret_task [CkFtp2_AppendFileAsync $localFilePath $remoteFilePath]

Creates an asynchronous task to call the AppendFile 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

# remoteFilename is a string
# content is a CkByteData
set status [CkFtp2_AppendFileFromBinaryData $remoteFilename $content]

Same as PutFileFromBinaryData, except the file on the FTP server is appended.

Returns 1 for success, 0 for failure.

# returns a CkTask
# remoteFilename is a string
# content is a CkByteData
set ret_task [CkFtp2_AppendFileFromBinaryDataAsync $remoteFilename $content]

Creates an asynchronous task to call the AppendFileFromBinaryData 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

# remoteFilename is a string
# textData is a string
# charset is a string
set status [CkFtp2_AppendFileFromTextData $remoteFilename $textData $charset]

Same as PutFileFromTextData, except the file on the FTP server is appended.

Returns 1 for success, 0 for failure.

# returns a CkTask
# remoteFilename is a string
# textData is a string
# charset is a string
set ret_task [CkFtp2_AppendFileFromTextDataAsync $remoteFilename $textData $charset]

Creates an asynchronous task to call the AppendFileFromTextData 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

CkFtp2_AsyncAbort

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

Causes an asynchronous Get or Put to abort.

This functionality is replaced by the new model for asynchronous programming introduced in Chilkat v9.5.0.52. Applications should use the new model, which is identified by methods having names ending with "Async" and return a task object.

# localFilename is a string
# remoteFilename is a string
set status [CkFtp2_AsyncAppendFileStart $localFilename $remoteFilename]

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

Initiates an asynchronous append. The file is uploaded and appended to an existing file on the FTP server. The append happens in a background thread and can be aborted by calling AsyncAbort. The AsyncFinished property can be checked periodically to determine when the background transfer is finished. The status of the transfer is available in the AsyncSuccess property. The last-error information is available in the AsyncLog property. The AsyncBytesSent property is updated in real time to reflect the current number of bytes sent while the transfer is in progress. The UploadRate is also updated with the current upload rate in bytes/second. While a transfer is in progress, a program may periodically read the UploadRate and AsyncBytesSent properties to display progress.

This functionality is replaced by the new model for asynchronous programming introduced in Chilkat v9.5.0.52. Applications should use the new model, which is identified by methods having names ending with "Async" and return a task object.

Returns 1 for success, 0 for failure.

# remoteFilename is a string
# localFilename is a string
set status [CkFtp2_AsyncGetFileStart $remoteFilename $localFilename]

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

Initiates an asynchronous file download. The download happens in a background thread and can be aborted by calling AsyncAbort. The AsyncFinished property can be checked periodically to determine when the background transfer is finished. The status of the transfer is available in the AsyncSuccess property. The last-error information is available in the AsyncLog property. The AsyncBytesReceived property is updated in real time to reflect the current number of bytes received while the transfer is in progress. The DownloadRate is also updated with the current download rate in bytes/second. While a transfer is in progress, a program may periodically read the DownloadRate and AsyncBytesReceived properties to display progress.

This functionality is replaced by the new model for asynchronous programming introduced in Chilkat v9.5.0.52. Applications should use the new model, which is identified by methods having names ending with "Async" and return a task object.

Returns 1 for success, 0 for failure.

# localFilename is a string
# remoteFilename is a string
set status [CkFtp2_AsyncPutFileStart $localFilename $remoteFilename]

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

Initiates an asynchronous file upload. The file is uploaded and creates a new file on the FTP server, or overwrites an existing file. The upload happens in a background thread and can be aborted by calling AsyncAbort. The AsyncFinished property can be checked periodically to determine when the background transfer is finished. The status of the transfer is available in the AsyncSuccess property. The last-error information is available in the AsyncLog property. The AsyncBytesSent property is updated in real time to reflect the current number of bytes sent while the transfer is in progress. The UploadRate is also updated with the current upload rate in bytes/second. While a transfer is in progress, a program may periodically read the UploadRate and AsyncBytesSent properties to display progress.

This functionality is replaced by the new model for asynchronous programming introduced in Chilkat v9.5.0.52. Applications should use the new model, which is identified by methods having names ending with "Async" and return a task object.

Returns 1 for success, 0 for failure.

# remoteDirPath is a string
set status [CkFtp2_ChangeRemoteDir $remoteDirPath]

Changes the current remote directory. The remoteDirPath should be relative to the current remote directory, which is initially the HOME directory of the FTP user account.

If the remoteDirPath contains non-English characters, it may be necessary to set the DirListingCharset property equal to "utf-8". Please refer to the documentation for the DirListingCharset property.

Returns 1 for success, 0 for failure.

# returns a CkTask
# remoteDirPath is a string
set ret_task [CkFtp2_ChangeRemoteDirAsync $remoteDirPath]

Creates an asynchronous task to call the ChangeRemoteDir 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

set status [CkFtp2_CheckConnection]

Introduced in version 9.5.0.44

Returns 1 if currently connected and logged into an FTP server, otherwise returns 0.

Note: This may cause a NOOP command to be sent to the FTP server.

Returns 1 for success, 0 for failure.

# returns a CkTask
set ret_task [CkFtp2_CheckConnectionAsync]

Introduced in version 9.5.0.44

Creates an asynchronous task to call the CheckConnection 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

set status [CkFtp2_ClearControlChannel]

Reverts the FTP control channel from SSL/TLS to an unencrypted channel. This may be required when using FTPS with AUTH TLS where the FTP client is behind a DSL or cable-modem router that performs NAT (network address translation). If the control channel is encrypted, the router is unable to translate the IP address sent in the PORT command for data transfers. By clearing the control channel, the data transfers will remain encrypted, but the FTP commands are passed unencrypted. Your program would typically clear the control channel after authenticating.

Returns 1 for success, 0 for failure.

# returns a CkTask
set ret_task [CkFtp2_ClearControlChannelAsync]

Creates an asynchronous task to call the ClearControlChannel 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

CkFtp2_ClearDirCache

TheNumFilesAndDirs property returns the count of files and sub-directories in the current remote FTP directory, according to the ListPattern property. For example, if ListPattern is set to "*.xml", then NumFilesAndDirs returns the count of XML files in the remote directory.

The 1st time it is accessed, the component will (behind the scenes) fetch the directory listing from the FTP server. This information is cached in the component until (1) the current remote directory is changed, or (2) the ListPattern is changed, or (3) the this method (ClearDirCache) is called.

CkFtp2_ClearSessionLog

Clears the in-memory session log.

set status [CkFtp2_Connect]

Connects and logs in to the FTP server using the username/password provided in the component properties. Check the integer value of the ConnectFailReason if this method returns 0 (indicating failure).

Note: To separately establish the connection and then authenticate (in separate method calls), call ConnectOnly followed by LoginAfterConnectOnly.

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 1 for success, 0 for failure.

# returns a CkTask
set ret_task [CkFtp2_ConnectAsync]

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

set status [CkFtp2_ConnectOnly]

Connects to the FTP server, but does not authenticate. The combination of calling this method followed by LoginAfterConnectOnly is the equivalent of calling the Connect method (which both connects and authenticates).

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 1 for success, 0 for failure.

FTP through SSH Tunnel

FTP Connect, Examine Server Certificate, and then Authenticate

# returns a CkTask
set ret_task [CkFtp2_ConnectOnlyAsync]

Creates an asynchronous task to call the ConnectOnly 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

set status [CkFtp2_ConvertToTls]

Explicitly converts the control channel to a secure SSL/TLS connection.

Note: If you initially connect with either the AuthTls or AuthSsl property set to 1, then DO NOT call ConvertToTls. The control channel is automatically converted to SSL/TLS from within the Connect method when these properties are set.

Note: It is very uncommon for this method to be needed.

Returns 1 for success, 0 for failure.

# returns a CkTask
set ret_task [CkFtp2_ConvertToTlsAsync]

Creates an asynchronous task to call the ConvertToTls 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

# localDir is a string
# outStr is a CkString (output)
set status [CkFtp2_CreatePlan $localDir $outStr]
set retStr [CkFtp2_createPlan $myFtp2 $localDir]

Creates an "FTP plan" that lists the FTP operations that would be performed when PutTree is called. Additionally, the PutPlan method executes an "FTP plan" and logs each successful operation to a plan log file. If a large-scale upload is interrupted, the PutPlan can be resumed, skipping over the operations already listed in the plan log file.

Returns 1 for success, 0 for failure.

Upload Directory Tree using a Plan

# returns a CkTask
# localDir is a string
set ret_task [CkFtp2_CreatePlanAsync $localDir]

Creates an asynchronous task to call the CreatePlan 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

# remoteDirPath is a string
set status [CkFtp2_CreateRemoteDir $remoteDirPath]

Creates a directory on the FTP server. If the directory already exists, a new one is not created and 0 is returned.

If the remoteDirPath contains non-English characters, it may be necessary to set the DirListingCharset property equal to "utf-8". Please refer to the documentation for the DirListingCharset property.

Returns 1 for success, 0 for failure.

Explaining 550 Create directory operation failed.

# returns a CkTask
# remoteDirPath is a string
set ret_task [CkFtp2_CreateRemoteDirAsync $remoteDirPath]

Creates an asynchronous task to call the CreateRemoteDir 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

# remotePattern is a string
set retInt [CkFtp2_DeleteMatching $remotePattern]

Deletes all the files in the current remote FTP directory matching the pattern. Returns the number of files deleted, or -1 for failure. The pattern is a string such as "*.txt", where any number of "*" wildcard characters can be used. "*" matches 0 or more of any character.

# returns a CkTask
# remotePattern is a string
set ret_task [CkFtp2_DeleteMatchingAsync $remotePattern]

Creates an asynchronous task to call the DeleteMatching 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

# remoteFilePath is a string
set status [CkFtp2_DeleteRemoteFile $remoteFilePath]

Deletes a file on the FTP server.

If the remoteFilePath contains non-English characters, it may be necessary to set the DirListingCharset property equal to "utf-8". Please refer to the documentation for the DirListingCharset property.

Returns 1 for success, 0 for failure.

# returns a CkTask
# remoteFilePath is a string
set ret_task [CkFtp2_DeleteRemoteFileAsync $remoteFilePath]

Creates an asynchronous task to call the DeleteRemoteFile 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

set status [CkFtp2_DeleteTree]

Deletes the entire subtree and all files from the current remote FTP directory. To delete a subtree on the FTP server, your program would first navigate to the root of the subtree to be deleted by calling ChangeRemoteDir, and then call DeleteTree. There are two event callbacks: VerifyDeleteFile and VerifyDeleteDir. Both are called prior to deleting each file or directory. The arguments to the callback include the full filepath of the file or directory, and an output-only "skip" flag. If your application sets the skip flag to true, the file or directory is NOT deleted. If a directory is not deleted, all files and sub-directories will remain. Example programs can be found at http://www.example-code.com/

Returns 1 for success, 0 for failure.

Delete FTP Directory Tree

# returns a CkTask
set ret_task [CkFtp2_DeleteTreeAsync]

Creates an asynchronous task to call the DeleteTree 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

set retInt [CkFtp2_DetermineProxyMethod]

Automatically determines the ProxyMethod that should be used with an FTP proxy server. Tries each of the five possible ProxyMethod settings and returns the value (1-5) of the ProxyMethod that succeeded.

This method may take a minute or two to complete. Returns 0 if no proxy methods were successful. Returns -1 to indicate an error (i.e. it was unable to test all proxy methods.)

Automatically Determine FTP Proxy Method

# returns a CkTask
set ret_task [CkFtp2_DetermineProxyMethodAsync]

Creates an asynchronous task to call the DetermineProxyMethod 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

# outXmlReport is a CkString (output)
set status [CkFtp2_DetermineSettings $outStr]
set retStr [CkFtp2_determineSettings $myFtp2]

Discovers which combinations of FTP2 property settings result in successful data transfers.

DetermineSettings tries 13 different combinations of these properties:

Ssl
AuthTls
AuthSsl
Port
Passive
PassiveUseHostAddr
Within the FTP protocol, the process of fetching a directory listing is also considered a "data transfer". The DetermineSettings method works by checking to see which combinations result in a successful directory listing download. The method takes no arguments and returns a string containing an XML report of the results. It is a blocking call that may take approximately a minute to run. If you are unsure about how to interpret the results, cut-and-paste it into an email and send it to support@chilkatsoft.com.

Returns 1 for success, 0 for failure.

DetermineSettings Example

# returns a CkTask
set ret_task [CkFtp2_DetermineSettingsAsync]

Creates an asynchronous task to call the DetermineSettings 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

# outStrXml is a CkString (output)
set status [CkFtp2_DirTreeXml $outStr]
set retStr [CkFtp2_dirTreeXml $myFtp2]

Recursively downloads the structure of a complete remote directory tree. Returns an XML document with the directory structure.

Note: Starting in version 9.5.0.47, the SyncMustMatch and SyncMustNotMatch properties apply to this method.

Returns 1 for success, 0 for failure.

Download Directory Tree Listing as XML

# returns a CkTask
set ret_task [CkFtp2_DirTreeXmlAsync]

Creates an asynchronous task to call the DirTreeXml 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

set status [CkFtp2_Disconnect]

Disconnects from the FTP server, ending the current session.

Returns 1 for success, 0 for failure.

# returns a CkTask
set ret_task [CkFtp2_DisconnectAsync]

Creates an asynchronous task to call the Disconnect 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

# localRoot is a string
set status [CkFtp2_DownloadTree $localRoot]

Downloads an entire tree from the FTP server and recreates the directory tree on the local filesystem.

This method downloads all the files and subdirectories in the current remote directory. An application would first navigate to the directory to be downloaded via ChangeRemoteDir and then call this method.

Note: Starting in version 9.5.0.47, the SyncMustMatch and SyncMustNotMatch properties apply to this method.

Returns 1 for success, 0 for failure.

Download Directory Tree Listing as XML

Determining Settings for FTP Data Connections

# returns a CkTask
# localRoot is a string
set ret_task [CkFtp2_DownloadTreeAsync $localRoot]

Creates an asynchronous task to call the DownloadTree 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

# outStr is a CkString (output)
set status [CkFtp2_Feat $outStr]
set retStr [CkFtp2_feat $myFtp2]

Sends a FEAT command to the FTP server and returns the response. Returns a zero-length string to indicate failure. Here is a typical response:

211-Features:
 MDTM
 REST STREAM
 SIZE
 MLST type*;size*;modify*;
 MLSD
 AUTH SSL
 AUTH TLS
 UTF8
 CLNT
 MFMT
211 End

Returns 1 for success, 0 for failure.

FTP FEAT Command

# returns a CkTask
set ret_task [CkFtp2_FeatAsync]

Creates an asynchronous task to call the Feat 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

# returns a CkDateTime
# index is an integer
set ret_ckDateTime [CkFtp2_GetCreateDt $index]

Returns the create date/time for the Nth file or sub-directory in the current remote directory. The first file/dir is at index 0, and the last one is at index (NumFilesAndDirs-1)

Returns NULL on failure

# returns a CkTask
# index is an integer
set ret_task [CkFtp2_GetCreateDtAsync $index]

Creates an asynchronous task to call the GetCreateDt 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

# returns a CkDateTime
# filename is a string
set ret_ckDateTime [CkFtp2_GetCreateDtByName $filename]

Returns the file-creation date/time for a remote file by filename.

Note: The filename passed to this method must NOT include a path. Prior to calling this method, make sure to set the current remote directory (via the ChangeRemoteDir method) to the remote directory where this file exists.

Note: Prior to calling this method, it should be ensured that the ListPattern property is set to a pattern that would match the requested filename. (The default value of ListPattern is "*", which will match all filenames.)

Note: Linux/Unix type filesystems do not store "create" date/times. Therefore, if the FTP server is on such as system, this method will return a date/time equal to the last-modified date/time.

Returns NULL on failure

# returns a CkTask
# filename is a string
set ret_task [CkFtp2_GetCreateDtByNameAsync $filename]

Creates an asynchronous task to call the GetCreateDtByName 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

# filename is a string
# outStr is a CkString (output)
set status [CkFtp2_GetCreateTimeByNameStr $filename $outStr]
set retStr [CkFtp2_getCreateTimeByNameStr $myFtp2 $filename]

Returns the file-creation date/time (in RFC822 string format, such as "Tue, 25 Sep 2012 12:25:32 -0500") for a remote file by filename.

Note: The filename passed to this method must NOT include a path. Prior to calling this method, make sure to set the current remote directory (via the ChangeRemoteDir method) to the remote directory where this file exists.

Note: Prior to calling this method, it should be ensured that the ListPattern property is set to a pattern that would match the requested filename. (The default value of ListPattern is "*", which will match all filenames.)

Note: Linux/Unix type filesystems do not store "create" date/times. If the FTP server is on such as system, this method will return a date/time equal to the last-modified date/time.

Returns 1 for success, 0 for failure.

# returns a CkTask
# filename is a string
set ret_task [CkFtp2_GetCreateTimeByNameStrAsync $filename]

Creates an asynchronous task to call the GetCreateTimeByNameStr 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

# index is an integer
# outStr is a CkString (output)
set status [CkFtp2_GetCreateTimeStr $index $outStr]
set retStr [CkFtp2_getCreateTimeStr $myFtp2 $index]

Returns the create time (in RFC822 string format, such as "Tue, 25 Sep 2012 12:25:32 -0500") for the Nth file or sub-directory in the current remote directory. The first file/dir is at index 0, and the last one is at index (NumFilesAndDirs-1)

Returns 1 for success, 0 for failure.

# returns a CkTask
# index is an integer
set ret_task [CkFtp2_GetCreateTimeStrAsync $index]

Creates an asynchronous task to call the GetCreateTimeStr 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

# outStr is a CkString (output)
set status [CkFtp2_GetCurrentRemoteDir $outStr]
set retStr [CkFtp2_getCurrentRemoteDir $myFtp2]

Returns the current remote directory.

Returns 1 for success, 0 for failure.

# returns a CkTask
set ret_task [CkFtp2_GetCurrentRemoteDirAsync]

Creates an asynchronous task to call the GetCurrentRemoteDir 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

set retInt [CkFtp2_GetDirCount]

Introduced in version 9.5.0.44

Returns the number of files and sub-directories in the current remote directory that match the ListPattern property.

Important: Calling this method may cause the directory listing to be retrieved from the FTP server. For FTP servers that do not support the MLST/MLSD commands, this is technically a data transfer that requires a temporary data connection to be established in the same way as when uploading or downloading files. If your program hangs while calling this method, it probably means that the data connection could not be established. The most common solution is to switch to using Passive mode by setting the Passive property = 1, with the PassiveUseHostAddr property also set equal to 1. If this does not help, examine the contents of the LastErrorText property after this method finally returns (after timing out). Also, see this Chilkat blog post about FTP connection settings.

# returns a CkTask
set ret_task [CkFtp2_GetDirCountAsync]

Introduced in version 9.5.0.44

Creates an asynchronous task to call the GetDirCount 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

# remoteFilePath is a string
# localFilePath is a string
set status [CkFtp2_GetFile $remoteFilePath $localFilePath]

Downloads a file from the FTP server to the local filesystem.

If the remoteFilePath contains non-English characters, it may be necessary to set the DirListingCharset property equal to "utf-8". Please refer to the documentation for the DirListingCharset property.

Returns 1 for success, 0 for failure.

Simple FTP Download

Determining Settings for FTP Data Connections

# returns a CkTask
# remoteFilePath is a string
# localFilePath is a string
set ret_task [CkFtp2_GetFileAsync $remoteFilePath $localFilePath]

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

Returns NULL on failure

Async FTP Progress Info

# remoteFilePath is a string
# binData is a CkBinData
set status [CkFtp2_GetFileBd $remoteFilePath $binData]

Introduced in version 9.5.0.62

Downloads a file from the FTP server into a BinData object.

If the remoteFilePath contains non-English characters, it may be necessary to set the DirListingCharset property equal to "utf-8". Please refer to the documentation for the DirListingCharset property.

Returns 1 for success, 0 for failure.

FTP Upload / Download to a BinData Object

# returns a CkTask
# remoteFilePath is a string
# binData is a CkBinData
set ret_task [CkFtp2_GetFileBdAsync $remoteFilePath $binData]

Introduced in version 9.5.0.62

Creates an asynchronous task to call the GetFileBd 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

# index is an integer
# outStr is a CkString (output)
set status [CkFtp2_GetFilename $index $outStr]
set retStr [CkFtp2_getFilename $myFtp2 $index]

Returns the filename for the Nth file or sub-directory in the current remote directory. The first file/dir is at index 0, and the last one is at index (NumFilesAndDirs-1)

Returns 1 for success, 0 for failure.

# returns a CkTask
# index is an integer
set ret_task [CkFtp2_GetFilenameAsync $index]

Creates an asynchronous task to call the GetFilename 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

# remoteFilePath is a string
# charset is a string
# sb is a CkStringBuilder
set status [CkFtp2_GetFileSb $remoteFilePath $charset $sb]

Introduced in version 9.5.0.62

Downloads a file from the FTP server into a StringBuilder object.

If the remoteFilePath contains non-English characters, it may be necessary to set the DirListingCharset property equal to "utf-8". Please refer to the documentation for the DirListingCharset property.

Returns 1 for success, 0 for failure.

FTP Upload / Download to StringBuilder

# returns a CkTask
# remoteFilePath is a string
# charset is a string
# sb is a CkStringBuilder
set ret_task [CkFtp2_GetFileSbAsync $remoteFilePath $charset $sb]

Introduced in version 9.5.0.62

Creates an asynchronous task to call the GetFileSb 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

# remoteFilePath is a string
# toStream is a CkStream
set status [CkFtp2_GetFileToStream $remoteFilePath $toStream]

Introduced in version 9.5.0.67

Downloads a file to a stream. If called synchronously, the remoteFilePath must have a sink, such as a file or another stream object. If called asynchronously, then the foreground thread can read the stream.

Returns 1 for success, 0 for failure.

# returns a CkTask
# remoteFilePath is a string
# toStream is a CkStream
set ret_task [CkFtp2_GetFileToStreamAsync $remoteFilePath $toStream]

Introduced in version 9.5.0.67

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

Returns NULL on failure

FTP Download Text File to a Stream

FTP Download Binary File to a Stream

# index is an integer
# outStr is a CkString (output)
set status [CkFtp2_GetGroup $index $outStr]
set retStr [CkFtp2_getGroup $myFtp2 $index]

Introduced in version 9.5.0.50

Returns group name, if available, for the Nth file. If empty, then no group information is available.

Note: When MLSD is used to get directory listings, it is likely that the owner and group information is not transmitted. In cases where the FTP server is on a UNIX/Linux system, the AllowMlsd property can be set to 0 to force UNIX directory listings instead of MLSD directory listings. This should result in being able to obtain owner/group information. However, it may sacrifice the quality and accuracy of the various date/time values that are returned.

Returns 1 for success, 0 for failure.

# returns a CkTask
# index is an integer
set ret_task [CkFtp2_GetGroupAsync $index]

Introduced in version 9.5.0.50

Creates an asynchronous task to call the GetGroup 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

# index is an integer
set retBool [CkFtp2_GetIsDirectory $index]

Returns 1 for a sub-directory and 0 for a file, for the Nth entry in the current remote directory. The first file/dir is at index 0, and the last one is at index (NumFilesAndDirs-1)

# returns a CkTask
# index is an integer
set ret_task [CkFtp2_GetIsDirectoryAsync $index]

Creates an asynchronous task to call the GetIsDirectory 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

# index is an integer
set retBool [CkFtp2_GetIsSymbolicLink $index]

Returns 1 if the remote file is a symbolic link. (Symbolic links only exist on Unix/Linux systems, not on Windows filesystems.)

# returns a CkTask
# index is an integer
set ret_task [CkFtp2_GetIsSymbolicLinkAsync $index]

Creates an asynchronous task to call the GetIsSymbolicLink 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

# returns a CkDateTime
# index is an integer
set ret_ckDateTime [CkFtp2_GetLastAccessDt $index]

Returns the last access date/time for the Nth file or sub-directory in the current remote directory. The first file/dir is at index 0, and the last one is at index (NumFilesAndDirs-1)

Returns NULL on failure

# returns a CkTask
# index is an integer
set ret_task [CkFtp2_GetLastAccessDtAsync $index]

Creates an asynchronous task to call the GetLastAccessDt 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

# returns a CkDateTime
# filename is a string
set ret_ckDateTime [CkFtp2_GetLastAccessDtByName $filename]

Returns a remote file's last-access date/time.

Note: The filename passed to this method must NOT include a path. Prior to calling this method, make sure to set the current remote directory (via the ChangeRemoteDir method) to the remote directory where this file exists.

Note: Prior to calling this method, it should be ensured that the ListPattern property is set to a pattern that would match the requested filename. (The default value of ListPattern is "*", which will match all filenames.)

Returns NULL on failure

# returns a CkTask
# filename is a string
set ret_task [CkFtp2_GetLastAccessDtByNameAsync $filename]

Creates an asynchronous task to call the GetLastAccessDtByName 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

# filename is a string
# outStr is a CkString (output)
set status [CkFtp2_GetLastAccessTimeByNameStr $filename $outStr]
set retStr [CkFtp2_getLastAccessTimeByNameStr $myFtp2 $filename]

Returns a remote file's last-access date/time in RFC822 string format, such as "Tue, 25 Sep 2012 12:25:32 -0500".

Note: The filename passed to this method must NOT include a path. Prior to calling this method, make sure to set the current remote directory (via the ChangeRemoteDir method) to the remote directory where this file exists.

Note: Prior to calling this method, it should be ensured that the ListPattern property is set to a pattern that would match the requested filename. (The default value of ListPattern is "*", which will match all filenames.)

Returns 1 for success, 0 for failure.

# returns a CkTask
# filename is a string
set ret_task [CkFtp2_GetLastAccessTimeByNameStrAsync $filename]

Creates an asynchronous task to call the GetLastAccessTimeByNameStr 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

# index is an integer
# outStr is a CkString (output)
set status [CkFtp2_GetLastAccessTimeStr $index $outStr]
set retStr [CkFtp2_getLastAccessTimeStr $myFtp2 $index]

Returns the last access date/time (in RFC822 string format, such as "Tue, 25 Sep 2012 12:25:32 -0500") for the Nth file or sub-directory in the current remote directory. The first file/dir is at index 0, and the last one is at index (NumFilesAndDirs-1)

Returns 1 for success, 0 for failure.

# returns a CkTask
# index is an integer
set ret_task [CkFtp2_GetLastAccessTimeStrAsync $index]

Creates an asynchronous task to call the GetLastAccessTimeStr 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

# returns a CkDateTime
# index is an integer
set ret_ckDateTime [CkFtp2_GetLastModDt $index]

Returns the last modified date/time for the Nth file or sub-directory in the current remote directory. The first file/dir is at index 0, and the last one is at index (NumFilesAndDirs-1)

Returns NULL on failure

# returns a CkTask
# index is an integer
set ret_task [CkFtp2_GetLastModDtAsync $index]

Creates an asynchronous task to call the GetLastModDt 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

# returns a CkDateTime
# filename is a string
set ret_ckDateTime [CkFtp2_GetLastModDtByName $filename]

Returns the last-modified date/time for a remote file.

Note: The filename passed to this method must NOT include a path. Prior to calling this method, make sure to set the current remote directory (via the ChangeRemoteDir method) to the remote directory where this file exists.

Note: Prior to calling this method, it should be ensured that the ListPattern property is set to a pattern that would match the requested filename. (The default value of ListPattern is "*", which will match all filenames.)

Returns NULL on failure

# returns a CkTask
# filename is a string
set ret_task [CkFtp2_GetLastModDtByNameAsync $filename]

Creates an asynchronous task to call the GetLastModDtByName 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

# filename is a string
# outStr is a CkString (output)
set status [CkFtp2_GetLastModifiedTimeByNameStr $filename $outStr]
set retStr [CkFtp2_getLastModifiedTimeByNameStr $myFtp2 $filename]

Returns a remote file's last-modified date/time in RFC822 string format, such as "Tue, 25 Sep 2012 12:25:32 -0500".

Note: The filename passed to this method must NOT include a path. Prior to calling this method, make sure to set the current remote directory (via the ChangeRemoteDir method) to the remote directory where this file exists.

Note: Prior to calling this method, it should be ensured that the ListPattern property is set to a pattern that would match the requested filename. (The default value of ListPattern is "*", which will match all filenames.)

Returns 1 for success, 0 for failure.

# returns a CkTask
# filename is a string
set ret_task [CkFtp2_GetLastModifiedTimeByNameStrAsync $filename]

Creates an asynchronous task to call the GetLastModifiedTimeByNameStr 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

# index is an integer
# outStr is a CkString (output)
set status [CkFtp2_GetLastModifiedTimeStr $index $outStr]
set retStr [CkFtp2_getLastModifiedTimeStr $myFtp2 $index]

Returns the last modified date/time (in RFC822 string format, such as "Tue, 25 Sep 2012 12:25:32 -0500") for the Nth file or sub-directory in the current remote directory. The first file/dir is at index 0, and the last one is at index (NumFilesAndDirs-1)

Returns 1 for success, 0 for failure.

# returns a CkTask
# index is an integer
set ret_task [CkFtp2_GetLastModifiedTimeStrAsync $index]

Creates an asynchronous task to call the GetLastModifiedTimeStr 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

# index is an integer
# outStr is a CkString (output)
set status [CkFtp2_GetOwner $index $outStr]
set retStr [CkFtp2_getOwner $myFtp2 $index]

Introduced in version 9.5.0.50

Returns owner name, if available, for the Nth file. If empty, then no owner information is available.

Note: When MLSD is used to get directory listings, it is likely that the owner and group information is not transmitted. In cases where the FTP server is on a UNIX/Linux system, the AllowMlsd property can be set to 0 to force UNIX directory listings instead of MLSD directory listings. This should result in being able to obtain owner/group information. However, it may sacrifice the quality and accuracy of the various date/time values that are returned.

Returns 1 for success, 0 for failure.

# returns a CkTask
# index is an integer
set ret_task [CkFtp2_GetOwnerAsync $index]

Introduced in version 9.5.0.50

Creates an asynchronous task to call the GetOwner 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

# index is an integer
# outStr is a CkString (output)
set status [CkFtp2_GetPermissions $index $outStr]
set retStr [CkFtp2_getPermissions $myFtp2 $index]

Introduced in version 9.5.0.50

Returns permissions information, if available, for the Nth file. If empty, then no permissions information is available. The value returned by the GetPermType method defines the content and format of the permissions string returned by this method. Possible permission types are "mlsd", "unix", "netware", "openvms", and "batchStatusFlags". The format of each permission type is as follows:


PermType: mlsd:

A "perm fact" is returned. The format of the perm fact is defined in RFC 3659 as follows:

  The perm fact is used to indicate access rights the current FTP user
   has over the object listed.  Its value is always an unordered
   sequence of alphabetic characters.

      perm-fact    = "Perm" "=" *pvals
      pvals        = "a" / "c" / "d" / "e" / "f" /
                     "l" / "m" / "p" / "r" / "w"

   There are ten permission indicators currently defined.  Many are
   meaningful only when used with a particular type of object.  The
   indicators are case independent, "d" and "D" are the same indicator.

   The "a" permission applies to objects of type=file, and indicates
   that the APPE (append) command may be applied to the file named.

   The "c" permission applies to objects of type=dir (and type=pdir,
   type=cdir).  It indicates that files may be created in the directory
   named.  That is, that a STOU command is likely to succeed, and that
   STOR and APPE commands might succeed if the file named did not
   previously exist, but is to be created in the directory object that
   has the "c" permission.  It also indicates that the RNTO command is
   likely to succeed for names in the directory.

   The "d" permission applies to all types.  It indicates that the
   object named may be deleted, that is, that the RMD command may be
   applied to it if it is a directory, and otherwise that the DELE
   command may be applied to it.

   The "e" permission applies to the directory types.  When set on an
   object of type=dir, type=cdir, or type=pdir it indicates that a CWD
   command naming the object should succeed, and the user should be able
   to enter the directory named.  For type=pdir it also indicates that
   the CDUP command may succeed (if this particular pathname is the one
   to which a CDUP would apply.)

   The "f" permission for objects indicates that the object named may be
   renamed - that is, may be the object of an RNFR command.

   The "l" permission applies to the directory file types, and indicates
   that the listing commands, LIST, NLST, and MLSD may be applied to the
   directory in question.

   The "m" permission applies to directory types, and indicates that the
   MKD command may be used to create a new directory within the
   directory under consideration.

   The "p" permission applies to directory types, and indicates that
   objects in the directory may be deleted, or (stretching naming a
   little) that the directory may be purged.  Note: it does not indicate
   that the RMD command may be used to remove the directory named
   itself, the "d" permission indicator indicates that.

   The "r" permission applies to type=file objects, and for some
   systems, perhaps to other types of objects, and indicates that the
   RETR command may be applied to that object.

   The "w" permission applies to type=file objects, and for some
   systems, perhaps to other types of objects, and indicates that the
   STOR command may be applied to the object named.

   Note: That a permission indicator is set can never imply that the
      appropriate command is guaranteed to work -- just that it might.
      Other system specific limitations, such as limitations on
      available space for storing files, may cause an operation to fail,
      where the permission flags may have indicated that it was likely
      to succeed.  The permissions are a guide only.

   Implementation note: The permissions are described here as they apply
      to FTP commands.  They may not map easily into particular
      permissions available on the server's operating system.  Servers
      are expected to synthesize these permission bits from the
      permission information available from operating system.  For
      example, to correctly determine whether the "D" permission bit
      should be set on a directory for a server running on the UNIX(TM)
      operating system, the server should check that the directory named
      is empty, and that the user has write permission on both the
      directory under consideration, and its parent directory.

      Some systems may have more specific permissions than those listed
      here, such systems should map those to the flags defined as best
      they are able.  Other systems may have only more broad access
      controls.  They will generally have just a few possible
      permutations of permission flags, however they should attempt to
      correctly represent what is permitted.

PermType: unix:

A Unix/Linux permissions string is returned ( such as "drwxr-xr-x" or "-rw-r--r--")

    The UNIX permissions string is 10 characters. Each character has a specific meaning. If the first character is:
    d 	the entry is a directory.
    b 	the entry is a block special file.
    c 	the entry is a character special file.
    l 	the entry is a symbolic link. Either the -N flag was specified, or the symbolic link did not point to an existing file.
    p 	the entry is a first-in, first-out (FIFO) special file.
    s 	the entry is a local socket.
    - 	the entry is an ordinary file.

    The next nine characters are divided into three sets of three characters each. The first set of three characters show 
the owner's permission. The next set of three characters show the permission of the other users in the group. The last
set of three characters shows the permission of anyone else with access to the file. The three characters in each set 
indicate, respectively, read, write, and execute permission of the file. With execute permission of a directory, you can search 
a directory for a specified file. Permissions are indicated like this:

    r 	read
    w 	write (edit)
    x 	execute (search)
    - 	corresponding permission not granted 

PermType: netware:

Contains the NetWare rights string from a NetWare FTP server directory listing format. For example "-WCE---S" or "RWCEAFMS".

Directory Rights	Description
----------------	-------------------------------
Read (R)		Read data from an existing file.
Write (W)		Write data to an existing file.
Create (C)		Create a new file or subdirectory.
Erase (E)		Delete an existing files or directory.
Modify (M)	Rename and change attributes of a file.
File Scan (F)	List the contents of a directory.
Access Control (A)	Control the rights of other users to access files or directories.
Supervisor (S)	Automatically allowed all rights.

PermType: openvms:

Contains the OpenVMS permissions string. For example "(RWED,RWED,RWED,RWED)", "(RWED,RWED,,)", "(RWED,RWED,R,R)", etc.


PermType: batchStatusFlags:

Contains the batch status flags from a Connect:Enterprise Server. Such as "-CR--M----" or "-ART------".

The Batch Status Flags  is a 10-character string where each character describes an attribute of the batch. 
A dash indicates that flag is turned off and therefore has no meaning to the 
batch in question. The flags are always displayed in the same order: 

1) I  -- Incomplete batch which will NOT be processed. 
2) A or C -- Added or Collected
3) R -- Requestable by partner 
4) T -- Transmitted to partner 
5) E -- Extracted (inbound file processed by McLane) 
6) M -- Multi-transmittable 
7) U -- Un-extractable 
8) N -- Non-transmittable 
9) P -- In Progress 
10) - -- Always a dash.

Returns 1 for success, 0 for failure.

Get FTP File Permissions

# returns a CkTask
# index is an integer
set ret_task [CkFtp2_GetPermissionsAsync $index]

Introduced in version 9.5.0.50

Creates an asynchronous task to call the GetPermissions 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

# index is an integer
# outStr is a CkString (output)
set status [CkFtp2_GetPermType $index $outStr]
set retStr [CkFtp2_getPermType $myFtp2 $index]

Introduced in version 9.5.0.50

Returns the type of permissions information that is available for the Nth file. If empty, then no permissions information is available. The value returned by this method defines the content and format of the permissions string returned by the GetPermissions method. Possible values are "mlsd", "unix", "netware", "openvms", and "batchStatusFlags".

Returns 1 for success, 0 for failure.

Get FTP File Permissions

# returns a CkTask
# index is an integer
set ret_task [CkFtp2_GetPermTypeAsync $index]

Introduced in version 9.5.0.50

Creates an asynchronous task to call the GetPermType 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

# remoteFilename is a string
# outData is a CkByteData (output)
set status [CkFtp2_GetRemoteFileBinaryData $remoteFilename $outData]

Downloads the contents of a remote file into a byte array.

Returns 1 for success, 0 for failure.

Determining Settings for FTP Data Connections

# returns a CkTask
# remoteFilename is a string
set ret_task [CkFtp2_GetRemoteFileBinaryDataAsync $remoteFilename]

Creates an asynchronous task to call the GetRemoteFileBinaryData 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

# remoteFilename is a string
# charset is a string
# outStr is a CkString (output)
set status [CkFtp2_GetRemoteFileTextC $remoteFilename $charset $outStr]
set retStr [CkFtp2_getRemoteFileTextC $myFtp2 $remoteFilename $charset]

Downloads a text file directly into a string variable. The character encoding of the text file is specified by the charset argument, which is a value such as utf-8, iso-8859-1, Shift_JIS, etc.

Returns 1 for success, 0 for failure.

Download Text File into String Variable

# returns a CkTask
# remoteFilename is a string
# charset is a string
set ret_task [CkFtp2_GetRemoteFileTextCAsync $remoteFilename $charset]

Creates an asynchronous task to call the GetRemoteFileTextC 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

# remoteFilename is a string
# outStr is a CkString (output)
set status [CkFtp2_GetRemoteFileTextData $remoteFilename $outStr]
set retStr [CkFtp2_getRemoteFileTextData $myFtp2 $remoteFilename]

Downloads the content of a remote text file directly into an in-memory string.

Note: If the remote text file does not use the ANSI character encoding, call GetRemoteFileTextC instead, which allows for the character encoding to be specified so that characters are properly interpreted.

Returns 1 for success, 0 for failure.

Determining Settings for FTP Data Connections

Download Text File into String Variable

# returns a CkTask
# remoteFilename is a string
set ret_task [CkFtp2_GetRemoteFileTextDataAsync $remoteFilename]

Creates an asynchronous task to call the GetRemoteFileTextData 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

# index is an integer
set retInt [CkFtp2_GetSize $index]

Returns the size of the Nth remote file in the current directory.

# returns a CkTask
# index is an integer
set ret_task [CkFtp2_GetSizeAsync $index]

Creates an asynchronous task to call the GetSize 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

# index is an integer
set retInt64 [CkFtp2_GetSize64 $index]

Returns the size of the Nth remote file in the current directory as a 64-bit integer. Returns -1 if the file does not exist.

# filename is a string
set retInt [CkFtp2_GetSizeByName $filename]

Returns a remote file's size in bytes. Returns -1 if the file does not exist.

Note: The filename passed to this method must NOT include a path. Prior to calling this method, make sure to set the current remote directory (via the ChangeRemoteDir method) to the remote directory where this file exists.

Note: Prior to calling this method, it should be ensured that the ListPattern property is set to a pattern that would match the requested filename. (The default value of ListPattern is "*", which will match all filenames.)

# returns a CkTask
# filename is a string
set ret_task [CkFtp2_GetSizeByNameAsync $filename]

Creates an asynchronous task to call the GetSizeByName 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

# filename is a string
set retInt64 [CkFtp2_GetSizeByName64 $filename]

Returns a remote file's size in bytes as a 64-bit integer.

Note: The filename passed to this method must NOT include a path. Prior to calling this method, make sure to set the current remote directory (via the ChangeRemoteDir method) to the remote directory where this file exists.

Note: Prior to calling this method, it should be ensured that the ListPattern property is set to a pattern that would match the requested filename. (The default value of ListPattern is "*", which will match all filenames.)

# index is an integer
# outStr is a CkString (output)
set status [CkFtp2_GetSizeStr $index $outStr]
set retStr [CkFtp2_getSizeStr $myFtp2 $index]

Returns the size in decimal string format of the Nth remote file in the current directory. This is helpful for cases when the file size (in bytes) is greater than what can fit in a 32-bit integer.

Returns 1 for success, 0 for failure.

# returns a CkTask
# index is an integer
set ret_task [CkFtp2_GetSizeStrAsync $index]

Creates an asynchronous task to call the GetSizeStr 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

# filename is a string
# outStr is a CkString (output)
set status [CkFtp2_GetSizeStrByName $filename $outStr]
set retStr [CkFtp2_getSizeStrByName $myFtp2 $filename]

Returns the size of a remote file as a string. This is helpful when file a file size is greater than what can fit in a 32-bit integer.

Note: The filename passed to this method must NOT include a path. Prior to calling this method, make sure to set the current remote directory (via the ChangeRemoteDir method) to the remote directory where this file exists.

Note: Prior to calling this method, it should be ensured that the ListPattern property is set to a pattern that would match the requested filename. (The default value of ListPattern is "*", which will match all filenames.)

Returns 1 for success, 0 for failure.

# returns a CkTask
# filename is a string
set ret_task [CkFtp2_GetSizeStrByNameAsync $filename]

Creates an asynchronous task to call the GetSizeStrByName 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

# returns a CkCert
set ret_cert [CkFtp2_GetSslServerCert]

Returns the FTP server's digital certificate (for SSL / TLS connections).

Returns NULL on failure

FTP Connect, Examine Server Certificate, and then Authenticate

# pattern is a string
# outStrRawListing is a CkString (output)
set status [CkFtp2_GetTextDirListing $pattern $outStr]
set retStr [CkFtp2_getTextDirListing $myFtp2 $pattern]

Returns a listing of the files and directories in the current directory matching the pattern. Passing "*.*" will return all the files and directories.

Returns 1 for success, 0 for failure.

Determining Settings for FTP Data Connections

# returns a CkTask
# pattern is a string
set ret_task [CkFtp2_GetTextDirListingAsync $pattern]

Creates an asynchronous task to call the GetTextDirListing 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

# pattern is a string
# outStrXmlListing is a CkString (output)
set status [CkFtp2_GetXmlDirListing $pattern $outStr]
set retStr [CkFtp2_getXmlDirListing $myFtp2 $pattern]

Returns (in XML format) the files and directories in the current directory matching the pattern. Passing "*.*" will return all the files and directories.

Returns 1 for success, 0 for failure.

Determining Settings for FTP Data Connections

Get FTP Directory Listing as XML

# returns a CkTask
# pattern is a string
set ret_task [CkFtp2_GetXmlDirListingAsync $pattern]

Creates an asynchronous task to call the GetXmlDirListing 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

set retBool [CkFtp2_IsUnlocked]

Return true if the component is already unlocked.

# localPath is a string
# remotePath is a string
# chunkSize is an integer
set status [CkFtp2_LargeFileUpload $localPath $remotePath $chunkSize]

Introduced in version 9.5.0.58

This is the same as PutFile, but designed to work around the following potential problem associated with an upload that is extremely large.

FTP uses two TCP (or TLS) connections: a control connection to submit commands and receive replies, and a data connection for actual file transfers. It is the nature of FTP that during a transfer the control connection stays completely idle. Many routers and firewalls automatically close idle connections after a certain period of time. Worse, they often don't notify the user, but just silently drop the connection.

For FTP, this means that during a long transfer the control connection can get dropped because it is detected as idle, but neither client nor server are notified. When all data has been transferred, the server assumes the control connection is alive and it sends the transfer confirmation reply.

Likewise, the client thinks the control connection is alive and it waits for the reply from the server. But since the control connection got dropped without notification, the reply never arrives and eventually the connection will timeout.

The Solution: This method uploads the file in chunks, where each chunk appends to the remote file. This way, each chunk is a separate FTP upload that does not take too long to complete. The chunkSize specifies the number of bytes to upload in each chunk. The size should be based on the amount of memory available (because each chunk will reside in memory as it's being uploaded), the transfer rate, and the total size of the file being uploaded. For example, if a 4GB file is uploaded, and the chunkSize is set to 1MB (1,048,576 bytes), then 4000 separate chunks would be required. This is likely not a good choice for chunkSize. A more appropriate chunkSize might be 20MB, in which case the upload would complete in 200 separate chunks. The application would temporarily be using a 20MB buffer for uploading chunks. The tradeoff is between the number of chunks (the more chunks, the larger the overall time to upload), the amount of memory that is reasonable for the temporary buffer, and the amount of time required to upload each chunk (if the chunk size is too large, then the problem described above is not solved).

Returns 1 for success, 0 for failure.

FTP Large File Upload

# returns a CkTask
# localPath is a string
# remotePath is a string
# chunkSize is an integer
set ret_task [CkFtp2_LargeFileUploadAsync $localPath $remotePath $chunkSize]

Introduced in version 9.5.0.58

Creates an asynchronous task to call the LargeFileUpload 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

set status [CkFtp2_LoginAfterConnectOnly]

Authenticates with the FTP server using the values provided in the Username, Password, and/or other properties. This can be called after establishing the connection via the ConnectOnly method. (The Connect method both connects and authenticates.) The combination of calling ConnectOnly followed by LoginAfterConnectOnly is the equivalent of calling the Connect method.

Note: After successful authentication, the FEAT and SYST commands are automatically sent to help the client understand what is supported by the FTP server. To prevent these commands from being sent, set the AutoFeat and/or AutoSyst properties equal to 0.

Returns 1 for success, 0 for failure.

FTP Connect, Examine Server Certificate, and then Authenticate

# returns a CkTask
set ret_task [CkFtp2_LoginAfterConnectOnlyAsync]

Creates an asynchronous task to call the LoginAfterConnectOnly 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

# remotePattern is a string
# localDir is a string
set retInt [CkFtp2_MGetFiles $remotePattern $localDir]

Copies all the files in the current remote FTP directory to a local directory. To copy all the files in a remote directory, set remotePattern to "*.*" The pattern can contain any number of "*"characters, where "*" matches 0 or more of any character. The return value is the number of files transferred, and on error, a value of -1 is returned. Detailed information about the transfer can be obtained from the last-error information (LastErrorText/LastErrorHtml/LastErrorXml/SaveLastError).

About case sensitivity: The MGetFiles command works by sending the "LIST" command to the FTP server. For example: "LIST *.txt". The FTP server responds with a directory listing of the files matching the wildcarded pattern, and it is these files that are downloaded. Case sensitivity depends on the case-sensitivity of the remote file system. If the FTP server is running on a Windows-based computer, it is likely to be case insensitive. However, if the FTP server is running on Linux, MAC OS X, etc. it is likely to be case sensitive. There is no good way to force case-insensitivity if the remote filesystem is case-sensitive because it is not possible for the FTP client to send a LIST command indicating that it wants the matching to be case-insensitive.

# returns a CkTask
# remotePattern is a string
# localDir is a string
set ret_task [CkFtp2_MGetFilesAsync $remotePattern $localDir]

Creates an asynchronous task to call the MGetFiles 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

# pattern is a string
set retInt [CkFtp2_MPutFiles $pattern]

Uploads all the files matching pattern on the local computer to the current remote FTP directory. The pattern parameter can include directory information, such as "C:/my_dir/*.txt" or it can simply be a pattern such as "*.*" that matches the files in the application's current directory. Subdirectories are not recursed. The return value is the number of files copied, with a value of -1 returned for errors. Detailed information about the transfer can be obtained from the XML log.[

# returns a CkTask
# pattern is a string
set ret_task [CkFtp2_MPutFilesAsync $pattern]

Creates an asynchronous task to call the MPutFiles 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

# remoteDirPattern is a string
# outStr is a CkString (output)
set status [CkFtp2_NlstXml $remoteDirPattern $outStr]
set retStr [CkFtp2_nlstXml $myFtp2 $remoteDirPattern]

Sends an NLST command to the FTP server and returns the results in XML format. The NLST command returns a list of filenames in the given directory (matching the pattern). The remoteDirPattern should be a pattern such as "*", "*.*", "*.txt", "subDir/*.xml", etc.

The format of the XML returned is:

<nlst>
<e>filename_or_dir_1</e>
<e>filename_or_dir_2</e>
<e>filename_or_dir_3</e>
<e>filename_or_dir_4</e>
...
</nlst>

Returns 1 for success, 0 for failure.

# returns a CkTask
# remoteDirPattern is a string
set ret_task [CkFtp2_NlstXmlAsync $remoteDirPattern]

Creates an asynchronous task to call the NlstXml 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

set status [CkFtp2_Noop]

Issues a no-op command to the FTP server.

Returns 1 for success, 0 for failure.

# returns a CkTask
set ret_task [CkFtp2_NoopAsync]

Creates an asynchronous task to call the Noop 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

# localFilePath is a string
# remoteFilePath is a string
set status [CkFtp2_PutFile $localFilePath $remoteFilePath]

Uploads a local file to the current directory on the FTP server.

If the remoteFilePath contains non-English characters, it may be necessary to set the DirListingCharset property equal to "utf-8". Please refer to the documentation for the DirListingCharset property.

Returns 1 for success, 0 for failure.

Simple FTP Upload

Determining Settings for FTP Data Connections

# returns a CkTask
# localFilePath is a string
# remoteFilePath is a string
set ret_task [CkFtp2_PutFileAsync $localFilePath $remoteFilePath]

Creates an asynchronous task to call the PutFile 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

# binData is a CkBinData
# remoteFilePath is a string
set status [CkFtp2_PutFileBd $binData $remoteFilePath]

Introduced in version 9.5.0.62

Uploads the contents of a BinData to a remote file.

If the remoteFilePath contains non-English characters, it may be necessary to set the DirListingCharset property equal to "utf-8". Please refer to the documentation for the DirListingCharset property.

Returns 1 for success, 0 for failure.

FTP Upload / Download to a BinData Object

# returns a CkTask
# binData is a CkBinData
# remoteFilePath is a string
set ret_task [CkFtp2_PutFileBdAsync $binData $remoteFilePath]

Introduced in version 9.5.0.62

Creates an asynchronous task to call the PutFileBd 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

# remoteFilename is a string
# content is a CkByteData
set status [CkFtp2_PutFileFromBinaryData $remoteFilename $content]

Creates a file on the remote server containing the data passed in a byte array.

Returns 1 for success, 0 for failure.

Determining Settings for FTP Data Connections

# returns a CkTask
# remoteFilename is a string
# content is a CkByteData
set ret_task [CkFtp2_PutFileFromBinaryDataAsync $remoteFilename $content]

Creates an asynchronous task to call the PutFileFromBinaryData 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

# remoteFilename is a string
# textData is a string
# charset is a string
set status [CkFtp2_PutFileFromTextData $remoteFilename $textData $charset]

Creates a file on the remote server containing the data passed in a string.

Returns 1 for success, 0 for failure.

Determining Settings for FTP Data Connections

# returns a CkTask
# remoteFilename is a string
# textData is a string
# charset is a string
set ret_task [CkFtp2_PutFileFromTextDataAsync $remoteFilename $textData $charset]

Creates an asynchronous task to call the PutFileFromTextData 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

# sb is a CkStringBuilder
# charset is a string
# includeBom is a boolean
# remoteFilePath is a string
set status [CkFtp2_PutFileSb $sb $charset $includeBom $remoteFilePath]

Introduced in version 9.5.0.62

Uploads the contents of a StringBuilder to a remote file.

If the charset contains non-English characters, it may be necessary to set the DirListingCharset property equal to "utf-8". Please refer to the documentation for the DirListingCharset property.

Returns 1 for success, 0 for failure.

FTP Upload / Download to StringBuilder

# returns a CkTask
# sb is a CkStringBuilder
# charset is a string
# includeBom is a boolean
# remoteFilePath is a string
set ret_task [CkFtp2_PutFileSbAsync $sb $charset $includeBom $remoteFilePath]

Introduced in version 9.5.0.62

Creates an asynchronous task to call the PutFileSb 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

# plan is a string
# alreadyDoneFilename is a string
set status [CkFtp2_PutPlan $plan $alreadyDoneFilename]

Executes an "FTP plan" (created by the CreatePlan method) and logs each successful operation to a plan log file. If a large-scale upload is interrupted, the PutPlan can be resumed, skipping over the operations already listed in the plan log file. When resuming an interrupted PutPlan method, use the same log file. All completed operations found in the already-existing log will automatically be skipped.

Returns 1 for success, 0 for failure.

Upload Directory Tree using a Plan

# returns a CkTask
# plan is a string
# alreadyDoneFilename is a string
set ret_task [CkFtp2_PutPlanAsync $plan $alreadyDoneFilename]

Creates an asynchronous task to call the PutPlan 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

# localDir is a string
set status [CkFtp2_PutTree $localDir]

Uploads an entire directory tree from the local filesystem to the remote FTP server, recreating the directory tree on the server. The PutTree method copies a directory tree to the current remote directory on the FTP server.

Returns 1 for success, 0 for failure.

# returns a CkTask
# localDir is a string
set ret_task [CkFtp2_PutTreeAsync $localDir]

Creates an asynchronous task to call the PutTree 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

# cmd is a string
set status [CkFtp2_Quote $cmd]

Sends an arbitrary (raw) command to the FTP server.

Returns 1 for success, 0 for failure.

Quote Example

# returns a CkTask
# cmd is a string
set ret_task [CkFtp2_QuoteAsync $cmd]

Creates an asynchronous task to call the Quote 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

# remoteDirPath is a string
set status [CkFtp2_RemoveRemoteDir $remoteDirPath]

Removes a directory from the FTP server.

If the remoteDirPath contains non-English characters, it may be necessary to set the DirListingCharset property equal to "utf-8". Please refer to the documentation for the DirListingCharset property.

Returns 1 for success, 0 for failure.

# returns a CkTask
# remoteDirPath is a string
set ret_task [CkFtp2_RemoveRemoteDirAsync $remoteDirPath]

Creates an asynchronous task to call the RemoveRemoteDir 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

# existingRemoteFilePath is a string
# newRemoteFilePath is a string
set status [CkFtp2_RenameRemoteFile $existingRemoteFilePath $newRemoteFilePath]

Renames a file or directory on the FTP server. To move a file from one directory to another on a remote FTP server, call this method and include the source and destination directory filepath.

If the existingRemoteFilePath or newRemoteFilePath contains non-English characters, it may be necessary to set the DirListingCharset property equal to "utf-8". Please refer to the documentation for the DirListingCharset property.

Returns 1 for success, 0 for failure.

# returns a CkTask
# existingRemoteFilePath is a string
# newRemoteFilePath is a string
set ret_task [CkFtp2_RenameRemoteFileAsync $existingRemoteFilePath $newRemoteFilePath]

Creates an asynchronous task to call the RenameRemoteFile 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

# path is a string
set status [CkFtp2_SaveLastError $path]

Saves the last-error information (the contents of LastErrorXml) to an XML formatted file.

Returns 1 for success, 0 for failure.

# cmd is a string
# outReply is a CkString (output)
set status [CkFtp2_SendCommand $cmd $outStr]
set retStr [CkFtp2_sendCommand $myFtp2 $cmd]

Sends an raw command to the FTP server and returns the raw response.

Returns 1 for success, 0 for failure.

SendCommand Example

# returns a CkTask
# cmd is a string
set ret_task [CkFtp2_SendCommandAsync $cmd]

Creates an asynchronous task to call the SendCommand 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

set status [CkFtp2_SetModeZ]

Chilkat FTP2 supports MODE Z, which is a transfer mode implemented by some FTP servers. It allows for files to be uploaded and downloaded using compressed streams (using the zlib deflate algorithm).

Call this method after connecting to enable Mode Z. Once enabled, all transfers (uploads, downloads, and directory listings) are compressed.

Returns 1 for success, 0 for failure.

# returns a CkTask
set ret_task [CkFtp2_SetModeZAsync]

Creates an asynchronous task to call the SetModeZ 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

# oldestDateTimeStr is a string
CkFtp2_SetOldestDateStr $oldestDateTimeStr

Used in conjunction with the DownloadTree method. Call this method prior to calling DownloadTree to set the oldest date for a file to be downloaded. When DownloadTree is called, any file older than this date will not be downloaded.

The oldestDateTimeStr should be a date/time string in RFC822 format, such as "Tue, 25 Sep 2012 12:25:32 -0500".

# option is a string
set status [CkFtp2_SetOption $option]

Introduced in version 9.5.0.57

This is a general purpose method to set miscellaneous options that might arise due to buggy or quirky FTP servers. The option is a string describing the option. The current list of possible options are:

  • "Microsoft-TLS-1.2-Workaround" -- This is to force the data connection to use TLS 1.0 instead of the default. It works around the Microsoft FTP server bug found here: https://support.microsoft.com/en-us/kb/2888853

To turn off an option, prepend the string "No-". For example "No-Microsoft-TLS-1.2-Workaround". All options are turned off by default.

Returns 1 for success, 0 for failure.

# password is a CkSecureString
set status [CkFtp2_SetPassword $password]

Introduced in version 9.5.0.71

Sets the password in a more secure way than setting the Password property. Calling this method is the equivalent of setting the Password property.

Returns 1 for success, 0 for failure.

# dateTimeStr is a string
# remoteFilename is a string
set status [CkFtp2_SetRemoteFileDateTimeStr $dateTimeStr $remoteFilename]

Sets the last-modified date/time of a file on the FTP server. The dateTimeStr should be a date/time string in RFC822 format, such as "Tue, 25 Sep 2012 12:25:32 -0500".

Important: Not all FTP servers support this functionality. Please see the information at the Chilkat blog below:

Returns 1 for success, 0 for failure.

Setting FTP date/time not supported by all FTP servers.

# returns a CkTask
# dateTimeStr is a string
# remoteFilename is a string
set ret_task [CkFtp2_SetRemoteFileDateTimeStrAsync $dateTimeStr $remoteFilename]

Creates an asynchronous task to call the SetRemoteFileDateTimeStr 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

# dt is a CkDateTime
# remoteFilename is a string
set status [CkFtp2_SetRemoteFileDt $dt $remoteFilename]

Sets the last-modified date/time of a file on the FTP server. Important: Not all FTP servers support this functionality. Please see the information at the Chilkat blog below:

Returns 1 for success, 0 for failure.

Setting FTP date/time not supported by all FTP servers.

FTP Set Remote File Date/Time Equal to Local File's Last-Modified Date/Time

# returns a CkTask
# dt is a CkDateTime
# remoteFilename is a string
set ret_task [CkFtp2_SetRemoteFileDtAsync $dt $remoteFilename]

Creates an asynchronous task to call the SetRemoteFileDt 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

# reqName is a string
# reqValue is a string
CkFtp2_SetSslCertRequirement $reqName $reqValue

Enforces a requirement on the FTP server's certificate. The reqName can be "SubjectDN", "SubjectCN", "IssuerDN", or "IssuerCN". The reqName specifies the part of the certificate, and the reqValue is the value that it must match (exactly). If the FTP server's certificate does not match, the SSL / TLS connection is aborted.

# cert is a CkCert
set status [CkFtp2_SetSslClientCert $cert]

Allows for a client-side certificate to be used for the SSL / TLS connection.

Returns 1 for success, 0 for failure.

# pemDataOrFilename is a string
# pemPassword is a string
set status [CkFtp2_SetSslClientCertPem $pemDataOrFilename $pemPassword]

Allows for a client-side certificate to be used for the SSL / TLS connection. If the PEM requires no password, pass an empty string in pemPassword. If the PEM is in a file, pass the path to the file in pemDataOrFilename. If the PEM is already loaded into a string variable, then pass the string containing the contents of the PEM in pemDataOrFilename.

Returns 1 for success, 0 for failure.

How to Create a PEM that Contains Certificates and a Private Key

# pfxFilename is a string
# pfxPassword is a string
set status [CkFtp2_SetSslClientCertPfx $pfxFilename $pfxPassword]

Allows for a client-side certificate to be used for the SSL / TLS connection.

Returns 1 for success, 0 for failure.

set status [CkFtp2_SetTypeAscii]

Set the FTP transfer mode to us-ascii.

Returns 1 for success, 0 for failure.

# returns a CkTask
set ret_task [CkFtp2_SetTypeAsciiAsync]

Creates an asynchronous task to call the SetTypeAscii 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

set status [CkFtp2_SetTypeBinary]

Set the FTP transfer mode to binary.

Returns 1 for success, 0 for failure.

# returns a CkTask
set ret_task [CkFtp2_SetTypeBinaryAsync]

Creates an asynchronous task to call the SetTypeBinary 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

# siteCommand is a string
set status [CkFtp2_Site $siteCommand]

Sends an arbitrary "site" command to the FTP server. The params argument should contain the parameters to the site command as they would appear on a command line. For example: "recfm=fb lrecl=600".

Returns 1 for success, 0 for failure.

# returns a CkTask
# siteCommand is a string
set ret_task [CkFtp2_SiteAsync $siteCommand]

Creates an asynchronous task to call the Site 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

# millisec is an integer
CkFtp2_SleepMs $millisec

Causes the calling process to sleep for a number of milliseconds.

# outStr is a CkString (output)
set status [CkFtp2_Stat $outStr]
set retStr [CkFtp2_ck_stat $myFtp2]

Sends a STAT command to the FTP server and returns the server's reply.

Returns 1 for success, 0 for failure.

# returns a CkTask
set ret_task [CkFtp2_StatAsync]

Creates an asynchronous task to call the Stat 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

# localRoot is a string
set status [CkFtp2_SyncDeleteRemote $localRoot]

Delete remote files that do not exist locally. The remote directory tree rooted at the current remote directory is traversed and remote files that have no corresponding local file are deleted.

Note: In v9.5.0.51 and higher, the list of deleted files is available in the SyncedFiles property.

Returns 1 for success, 0 for failure.

# returns a CkTask
# localRoot is a string
set ret_task [CkFtp2_SyncDeleteRemoteAsync $localRoot]

Creates an asynchronous task to call the SyncDeleteRemote 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

# localRoot is a string
# mode is an integer
set status [CkFtp2_SyncLocalDir $localRoot $mode]

The same as SyncLocalTree, except the sub-directories are not traversed. The files in the current remote directory are synchronized (downloaded) with the files in localRoot. For possible mode settings, see SyncLocalTree.

Note: In v9.5.0.51 and higher, the list of downloaded files is available in the SyncedFiles property.

Returns 1 for success, 0 for failure.

# returns a CkTask
# localRoot is a string
# mode is an integer
set ret_task [CkFtp2_SyncLocalDirAsync $localRoot $mode]

Creates an asynchronous task to call the SyncLocalDir 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

# localRoot is a string
# mode is an integer
set status [CkFtp2_SyncLocalTree $localRoot $mode]

Downloads files from the FTP 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.
* There is no mode #4. It is a mode used internally by the DirTreeXml method.

Note: In v9.5.0.51 and higher, the list of downloaded (or deleted) files is available in the SyncedFiles property.

Returns 1 for success, 0 for failure.

Example: Synchronize Local Directory Tree

# returns a CkTask
# localRoot is a string
# mode is an integer
set ret_task [CkFtp2_SyncLocalTreeAsync $localRoot $mode]

Creates an asynchronous task to call the SyncLocalTree 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

# localRoot is a string
# mode is an integer
set status [CkFtp2_SyncRemoteTree $localRoot $mode]

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

mode=0: Upload all files
mode=1: Upload all files that do not exist on the FTP server.
mode=2: Upload newer or non-existant files.
mode=3: Upload only newer files. If a file does not already exist on the FTP 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.

Note: In v9.5.0.51 and higher, the list of uploaded files is available in the SyncedFiles property.

Returns 1 for success, 0 for failure.

Example: Synchronize Remote Directory Tree

# returns a CkTask
# localRoot is a string
# mode is an integer
set ret_task [CkFtp2_SyncRemoteTreeAsync $localRoot $mode]

Creates an asynchronous task to call the SyncRemoteTree 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

# localDirPath is a string
# mode is an integer
# bDescend is a boolean
# bPreviewOnly is a boolean
set status [CkFtp2_SyncRemoteTree2 $localDirPath $mode $bDescend $bPreviewOnly]

Same as SyncRemoteTree, except two extra arguments are added to allow for more flexibility. If bDescend is 0, then the directory tree is not descended and only the files in localDirPath are synchronized. If bPreviewOnly is 1 then no files are transferred and instead the files that would've been transferred (had bPreviewOnly been set to 0) are listed in the SyncPreview property.

Note: If bPreviewOnly is set to 1, the remote directories (if they do not exist) are created. It is only the files that are not uploaded.

Note: In v9.5.0.51 and higher, the list of uploaded files is available in the SyncedFiles property.

Returns 1 for success, 0 for failure.

Delete Local Files that Do Not Exist on the FTP Server

# returns a CkTask
# localDirPath is a string
# mode is an integer
# bDescend is a boolean
# bPreviewOnly is a boolean
set ret_task [CkFtp2_SyncRemoteTree2Async $localDirPath $mode $bDescend $bPreviewOnly]

Creates an asynchronous task to call the SyncRemoteTree2 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

# outStr is a CkString (output)
set status [CkFtp2_Syst $outStr]
set retStr [CkFtp2_syst $myFtp2]

Sends a SYST command to the FTP server to find out the type of operating system at the server. The method returns the FTP server's response string. Refer to RFC 959 for details.

Returns 1 for success, 0 for failure.

# returns a CkTask
set ret_task [CkFtp2_SystAsync]

Creates an asynchronous task to call the Syst 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

# unlockCode is a string
set status [CkFtp2_UnlockComponent $unlockCode]

Unlocks the component. This must be called once prior to calling any other method. A purchased unlock code for FTP2 should contain the substring "FTP", or can be a Bundle unlock code.

Returns 1 for success, 0 for failure.

Diagnosing UnlockComponent Problems

UnlockComponent LastErrorText shows exact string passed to it.

Verify UnlockComponent Success w/ Purchased Unlock Code

LastErrorText Standard Information