Ftp2

Set to true to request cancellation of the operation currently running on this object. Long-running network and file-transfer methods periodically check this property; methods that complete quickly may finish before the request is observed.

A synchronous call can be cancelled from another thread by setting this property on the same object. The property is reset to false after cancellation is processed, and a stale request is cleared when a later method begins.

Specifies the FTP account string sent with the ACCT command when a server requires an account in addition to the username and password.

Specifies the last local TCP port that may be used for active-mode data connections. The default is 0. Valid nonzero values are 1 through 65535.

The range beginning with ActivePortRangeStart is inclusive. If ActivePortRangeStart is 0, this property is ignored and the operating system chooses an ephemeral listening port. If this value is 0 or is less than ActivePortRangeStart, Chilkat behaves as though both endpoints equal ActivePortRangeStart.

Unavailable ports are skipped. Chilkat tries each port in the effective range until binding succeeds, and fails only after all ports have been tried. The range applies to both PORT and EPRT and may be changed while the control connection is already established.

Specifies the first local TCP port that may be used for active-mode data connections. The default is 0. Valid nonzero values are 1 through 65535.

When this property is 0, ActivePortRangeEnd is ignored and Chilkat binds the listening socket to port 0, allowing the operating system to choose an available ephemeral port. When this property is nonzero, the effective range is inclusive. If the ending value is 0 or is less than the starting value, Chilkat tries only the starting port.

For each active-mode data connection, Chilkat tries the ports in the effective range in ascending order, skipping any port for which the listening socket cannot be bound. The operation fails only after every port in the range has been tried.

Specifies the size, in bytes, to send in an ALLO command before the next upload. For example, a value of 20 sends ALLO 20. The default value of 0 disables the command.

This is a one-shot setting. It is consumed by the next applicable upload and automatically reset to 0. A successful FTP reply indicating that allocation is unnecessary, such as reply code 202, does not prevent the upload from continuing.

ALLO asks the server to reserve storage for the incoming file. Some specialized or quota-managed servers require the allocation request before accepting the transfer.

Controls whether machine-readable directory listings are requested with MLSD when the server advertises support. The default is true.

When this property is true and MLSD is advertised, Chilkat uses MLSD. Otherwise, a legacy listing is used: NLST when PreferNlst is true, or LIST when it is false.

MLSD provides standardized facts such as type, size, and modification time and is generally more reliable than parsing server-specific LIST output. Facts not supplied by the server remain unavailable. When a perm fact is present, GetPermissions returns it rather than a UNIX-style permission string.

The TLS upgrade is completed before USER and PASS are sent. ConnectOnly performs the explicit TLS upgrade but does not log in. During Connect, Chilkat sends PBSZ and PROT as required by DataProtection. If the server responds with 530 Please login with USER and PASS, Chilkat logs in and automatically retries those commands.

If the server accepts the AUTH command but rejects a required PBSZ or PROT command, the connection attempt fails. A failed connection attempt does not leave the underlying plain FTP connection open.

AUTH SSL is the alternative explicit-TLS command used by this property. If Ssl is true, implicit TLS takes priority. If both this property and AuthTls are true while Ssl is false, AuthTls takes priority and Chilkat sends AUTH TLS.

Set to true to use explicit FTP over TLS by sending AUTH TLS on the FTP control channel. The client first establishes a plain FTP control connection, receives the server greeting, and then upgrades that connection to TLS. Port 21 is conventionally used.

The TLS upgrade is completed before USER and PASS are sent. ConnectOnly performs the explicit TLS upgrade but does not log in. During Connect, Chilkat sends PBSZ and PROT as required by DataProtection. If the server responds with 530 Please login with USER and PASS, Chilkat logs in and automatically retries those commands.

If the server accepts the AUTH command but rejects a required PBSZ or PROT command, the connection attempt fails. A failed connection attempt does not leave the underlying plain FTP connection open.

If Ssl is true, implicit TLS takes priority and this property is ignored. If both AuthTls and AuthSsl are true while Ssl is false, AuthTls takes priority.

When AutoSyst is also true, automatic SYST is sent first. If UTF8 is advertised and AutoOptsUtf8 is true, capability processing is followed by OPTS UTF8 ON.

The same capability processing can be performed later by calling Feat explicitly.

Controls automatic adjustment of Ssl, AuthSsl, and AuthTls based solely on Port. The default is true. The only recognized ports are 21 and 990.

Controls whether Chilkat sends a SIZE command before a download so percentage-based progress can be calculated. The default is false. Each size query adds a control-channel round trip.

A nonzero one-shot value in ProgressMonSize or ProgressMonSize64 supplies the expected size directly and avoids this additional query. Even when this property is false, percentage progress may be available if the server includes a usable size in its preliminary transfer reply.

Controls whether OPTS UTF8 ON is sent automatically when a processed FEAT response advertises UTF8. The default is true. When UTF-8 is advertised, Chilkat sets CommandCharset and DirListingCharset to utf-8, overwriting values previously assigned by the application.

If UTF8 is not advertised, the existing charset property values are left unchanged. This behavior applies both during automatic capability discovery and when Feat is called explicitly.

Set to false for a server that advertises UTF-8 but rejects the option or uses a different encoding in practice.

The result is based on both the advertised capabilities and the connection context; it is not simply a copy of whether EPSV appears in the FEAT reply. For example, an IPv4 connection may retain UseEpsv = FALSE even when the server advertises EPSV. Automatic recalculation can overwrite an explicitly assigned value, and each new connection recalculates it for the new session.

If an attempted EPSV command is rejected, Chilkat falls back to PASV for that data connection. The failed attempt is not remembered as a session-wide reason to disable future EPSV attempts.

Controls whether a SYST command is sent automatically after login. The default is true. The server's operating-system type can help Chilkat interpret legacy LIST output and other server-specific behavior.

When both this property and AutoFeat are true, automatic SYST occurs before automatic FEAT.

Set to false only when a particular server rejects or mishandles SYST.

Controls automatic post-upload verification with the server-specific XCRC command. The default is false. When enabled and the server supports XCRC, Chilkat requests a CRC after an upload and treats a mismatch as transfer failure.

If XCRC support is not detected, Chilkat does not send the verification command and the upload proceeds normally. This extension is not part of the core FTP standard and is not supported by every server. Capability detection normally depends on a processed FEAT response.

Specifies the approximate maximum download rate in bytes per second. The default value of 0 disables throttling.

Client-side download throttling is approximate because the server continues sending as permitted by TCP. The operating system's socket buffers absorb data between reads, so very small transfers may complete before the configured rate can be meaningfully enforced.

Specifies the approximate maximum upload rate in bytes per second. The default value of 0 disables throttling.

The limit is averaged over the transfer. Very small uploads may complete before the configured rate can be closely approximated.

This property is normally left unset. Set it only on a multihomed computer when the application must bind the outgoing connection to a specific local network interface.

Specify a numeric IPv4 or IPv6 address, not a hostname. When the property is empty, the operating system automatically chooses the local address.

Specifies the character encoding used by high-level FTP operations for commands containing non-ASCII text, including remote paths and filenames. The default is ANSI. Charset names and the keyword ANSI are case-insensitive. An unrecognized charset name is clamped to utf-8, and the getter returns utf-8.

Changing this property after connecting affects subsequent high-level FTP commands. If a character cannot be represented in a selected single-byte encoding, the character is omitted from the transmitted command; use utf-8 to preserve full Unicode names.

Contains a numeric reason code after Connect or ConnectOnly fails. Use this value for broad classification and inspect LastErrorText for detailed diagnostics.

A successful connection sets this property to 0. An authentication failure can set it to 301 while ConnectVerified remains true, because the TCP and FTP connection succeeded before the login was rejected.

Specifies the maximum number of seconds to wait for a remote endpoint to accept a TCP connection. The default is 30. A value of 0 or any negative value waits indefinitely.

This timeout applies whenever Ftp2 establishes a TCP connection, including the FTP control connection, FTP data connections, and connections to configured proxy servers.

It covers only TCP connection establishment. It does not apply to TLS handshakes, FTP greetings or replies, authentication, file data, or any other communication after the TCP connection has been accepted.

Indicates whether the TCP connection to the FTP server was successfully established during the most recent connection attempt. It does not indicate that FTP authentication succeeded; see LoginVerified.

This is a verification result, not a current-socket-state property. It remains true after Disconnect if the preceding connection was successfully established.

Controls line-ending conversion when downloading in ASCII transfer mode. The default is 0.

Returns the number of bytes received by the current or most recently completed FTP download as a 32-bit unsigned integer. The value is updated while the transfer is in progress and may be read from another thread to display progress. A subsequent upload does not clear the retained download count.

Returns the number of bytes received by the current or most recently completed FTP download as a 64-bit integer. The value is updated while the transfer is in progress and may be read from another thread to display progress. A subsequent upload does not clear the retained download count.

Returns the number of bytes received by the current or most recently completed FTP download as a decimal string. The value is updated while the transfer is in progress and may be read from another thread to display progress. A subsequent upload does not clear the retained download count.

Returns the number of bytes sent by the current or most recently completed FTP upload as a 32-bit unsigned integer. The value is updated while the transfer is in progress and may be read from another thread to display progress. A subsequent download does not clear the retained upload count.

Returns the number of bytes sent by the current or most recently completed FTP upload as a 64-bit integer. The value is updated while the transfer is in progress and may be read from another thread to display progress. A subsequent download does not clear the retained upload count.

Returns the number of bytes sent by the current or most recently completed FTP upload as a decimal string. The value is updated while the transfer is in progress and may be read from another thread to display progress. A subsequent download does not clear the retained upload count.

Specifies the protection level for FTP data connections. The value is compared case-insensitively. The default is control.

Connect sends the required PBSZ and PROT commands. If the server requires login first and replies with 530 Please login with USER and PASS, Chilkat authenticates and automatically retries them. A required protection setup fails only when no acceptable protection level can be established.

If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. This logging helps identify the context and history of Chilkat calls leading up to any crash or hang, aiding in debugging.

Enabling the VerboseLogging property provides more detailed information. This property is mainly used for debugging rare instances where a Chilkat method call causes a hang or crash, which should generally not happen.

Possible causes of hangs include:

• A timeout property set to 0, indicating an infinite timeout.
• A hang occurring within an event callback in the application code.
• An internal bug in the Chilkat code causing the hang.

Specifies the character encoding used only to decode directory-listing and related server-response bytes. It applies to responses from LIST, NLST, and MLSD. It does not affect commands, remote paths, filenames, usernames, passwords, or other text sent to the server.

The default is ANSI. Charset names and the keyword ANSI are case-insensitive. ANSI means the platform's system-default single-byte encoding or default system locale; on Windows, this is the active code page (ACP).

Using the wrong encoding can produce incorrectly decoded names without causing the listing operation itself to fail. When AutoOptsUtf8 is enabled and UTF-8 support is advertised, Chilkat changes this property to utf-8, even if the application previously assigned another value. If UTF-8 is not advertised, the existing value is left unchanged.

Returns the current average download rate in bytes per second. The value is updated during synchronous and asynchronous downloads and describes the download in progress or the most recently completed download. A subsequent upload does not clear the retained download rate.

Controls automatic resolution of credential values from secure operating-system storage. The default is false. When enabled, supported password properties may contain a secret specification beginning with !! instead of the literal password.

!![appName|]service[|domain]|username

Secret specifications are supported by Password, HttpProxyPassword, ProxyPassword, and SocksPassword. Chilkat resolves them through Windows Credential Manager on Windows or Apple Keychain on macOS.

Specifies the IPv4 address advertised to the server for active-mode data connections. This property affects both PORT and EPRT. Supply a numeric IPv4 address, the keyword control, or an IPv4 address prefixed with bind-. IPv6 values are not accepted. Keywords and prefixes are case-insensitive.

• control uses the local IPv4 address of the established FTP control socket.
• bind-192.0.2.10 advertises the address and also binds the local data-listener socket to that address.
• A plain IPv4 address changes the address sent in PORT or EPRT without explicitly binding the listener to that address.

If ClientIpAddress is set, this property should specify the same local address. When a bind- value is used with ActivePortRangeStart and ActivePortRangeEnd, Chilkat binds to the specified address while searching the effective range for an available port.

Contains the initial FTP server greeting received for the most recent connection immediately after the TCP or implicit-TLS connection was established. It normally begins with reply code 220 and may include server identification or policy information.

The value remains available after Disconnect.

Indicates whether the FTP server advertised support for MODE Z, which compresses FTP data streams using the DEFLATE algorithm.

This property becomes meaningful after Chilkat has processed a successful FEAT response, either automatically because AutoFeat is true or through an explicit call to Feat. Before capability discovery, a value of false does not establish that the server lacks MODE Z support.

Call SetModeZ after connecting to enable or disable compressed transfer mode.

Specifies the FTP server hostname or numeric IPv4/IPv6 address. Do not include a URL scheme, path, or port; configure the port separately with Port.

Specifies the authentication method used with an HTTP proxy. Supported values are Basic and NTLM. Leave empty when the proxy does not require authentication.

Specifies the Windows domain used for NTLM authentication to the HTTP proxy. It is ignored for Basic authentication and may be left empty when the username already includes the required domain information.

Specifies the hostname or numeric IP address of an HTTP proxy used to establish the FTP control connection. Leave empty to connect directly.

Specifies the password used to authenticate to the HTTP proxy. It is used together with HttpProxyUsername and HttpProxyAuthMethod.

Specifies the TCP port of the HTTP proxy. Common values include 8080 and 3128, but the correct value is determined by the proxy configuration.

Specifies the username used to authenticate to the HTTP proxy. Leave empty when the proxy allows unauthenticated connections.

Specifies the maximum period, in milliseconds, during which no control-channel response or forward upload progress is observed. The default is 60000. A value of 0 or any negative value waits indefinitely.

During an upload, the same limit applies when the operating-system send buffer remains full because the server is not consuming data.

Deprecated. Indicates whether the object appears to be connected and authenticated. Reading this property may send NOOP to test the session. Use CheckConnection instead.

Controls collection of an in-memory FTP protocol log. When enabled, commands and server replies are available in SessionLog. Use ClearSessionLog to discard previously collected text.

Controls an additional keepalive measure for very long uploads and downloads. The default is false. When enabled, Chilkat sends NOOP on the FTP control channel once per minute while a long-running file transfer is in progress.

This helps prevent the otherwise idle control connection from being closed by the server, a firewall, or a NAT device while file data continues on the separate data connection.

Provides HTML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

Provides plain text information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

Provides XML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

Indicates the success or failure of the most recent method call: true means success, false means failure. This property remains unchanged by property setters or getters. This method is present to address challenges in checking for null or Nothing returns in certain programming languages. Note: This property does not apply to methods that return integer values or to boolean-returning methods where the boolean does not indicate success or failure.

Contains the most recent FTP control-channel reply, including its three-digit status code and message. Examples include 250 Directory successfully changed. and 550 Failed to change directory.

The value is updated by successful as well as failed commands. After Disconnect, it normally contains the server's reply to QUIT, such as 221 Goodbye.. Some replies are multiline; use this property together with the method return value and LastErrorText when diagnosing a failure.

Specifies an option string appended literally to the legacy LIST command, such as -a. For example, setting this property to -a sends LIST -a. Chilkat does not interpret the option locally. It has no effect when AllowMlsd causes MLSD to be used or when PreferNlst causes NLST to be used.

LIST options and output formats are not standardized by FTP. Many UNIX-like servers pass the option to an underlying ls implementation, while other servers may reject or interpret it differently.

Specifies the case-insensitive wildcard pattern applied to the cached listing of the current remote directory. The default is *. It affects methods such as GetDirCount, GetFilename, GetIsDirectory, GetSize, and the listing timestamp methods.

Chilkat retrieves the full directory listing and applies this pattern locally; the pattern is not appended to LIST, NLST, or MLSD. For example, *.txt also matches a name such as UPPER.TXT.

Specify only a name pattern, such as *.txt. To list subdir/*.txt, first call ChangeRemoteDir for subdir, then set this property to *.txt.

Indicates whether FTP authentication succeeded during the most recent login attempt. A TCP connection may be established even when this property is false; for example, rejected credentials leave ConnectVerified true and this property false.

This is a verification result, not a current-socket-state property. It remains true after Disconnect if the preceding session was successfully authenticated.

Indicates whether the most recent download method received some, but not all, of the remote file. It is false when no data was received or when the complete file was received.

This property helps distinguish a mid-transfer failure from a failure that occurred before any file data arrived.

Selects the FTP data-connection mode. The default is true for passive mode. Set to false for active mode.

Controls how the address returned by PASV is handled. The default is true. When enabled, Chilkat ignores the IP address embedded in the server's PASV reply and connects to the control connection's server address using only the returned port.

This avoids private or otherwise unreachable addresses returned by FTP servers behind NAT, especially when TLS prevents a network device from rewriting the reply.

Specifies the password used for FTP authentication. For anonymous FTP, this is commonly an email address or arbitrary identifying string. Applications that already store the password in a SecureString should use SetSecurePassword instead.

Specifies the FTP server port. Port 21 is conventionally used for plain FTP or explicit FTPS, and port 990 is conventionally used for implicit FTPS.

When AutoFix is true, only these two port numbers cause automatic changes to Ssl, AuthSsl, and AuthTls. A custom port leaves all three TLS-mode properties unchanged.

Controls the preferred address family when DNS resolution returns both IPv4 and IPv6 addresses. The default is false, which prefers IPv4. Set it to true to prefer IPv6.

Controls whether NLST is preferred over LIST when a legacy directory listing is required. The default is false. This property is consulted only when AllowMlsd does not result in MLSD being used.

NLST generally returns names only. Do not rely on indexed sizes, timestamps, ownership, group, or permission information after an NLST listing. Because NLST does not reliably identify entry types, Chilkat may send additional commands, such as directory-change tests, to determine which names are directories.

Specifies the expected size, in bytes, of the next file downloaded by GetFile when the size is not otherwise known. Chilkat uses the value to calculate percentage progress.

This is a one-shot setting. It is consumed by the next applicable download and automatically reset to 0. Set it immediately before the download. When a nonzero value is supplied, Chilkat does not need the additional size query controlled by AutoGetSizeForProgress.

If this property is zero, percentage progress may still be available when the server's preliminary transfer reply includes the file size.

The 64-bit form of ProgressMonSize. Specifies the expected size, in bytes, of the next download when the value may exceed the 32-bit integer range. It is consumed by the next applicable download and automatically reset to 0.

Specifies the hostname or IP address of a traditional FTP application proxy or firewall. This is distinct from an HTTP CONNECT proxy and from a SOCKS proxy. The login sequence is selected by ProxyMethod.

Selects the login sequence required by a traditional FTP proxy or firewall. The default is 0, meaning no FTP proxy. Configure ProxyHostname, ProxyPort, and the required proxy credentials before connecting.

USER ProxyUsername
PASS ProxyPassword
SITE Hostname
USER Username
PASS Password

USER Username@Hostname:Port
PASS Password

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

USER Username@Hostname:Port ProxyUsername
PASS Password
ACCT ProxyPassword

USER ProxyUsername
PASS ProxyPassword
OPEN Hostname
USER Username
PASS Password

USER ProxyUsername@Hostname
USER Username
PASS Password

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

USER Username@ProxyUsername@Hostname
PASS Password@ProxyPassword

ProxyUsername
ProxyPassword
Username
Password

Specifies the password used to authenticate to a traditional FTP proxy or firewall. Its placement in the login exchange depends on ProxyMethod.

Specifies the TCP port on which the traditional FTP proxy or firewall accepts connections.

Specifies the username used to authenticate to a traditional FTP proxy or firewall. Its placement in the login exchange depends on ProxyMethod.

Specifies the maximum number of seconds that a data connection may remain without receiving another byte. The default is 60. A value of 0 or any negative value waits indefinitely.

This is an inactivity timeout, not a limit on total transfer duration. Receiving any data, even a single byte, resets the timer and begins a new full timeout interval. A large download may therefore continue indefinitely as long as data keeps arriving within the configured interval.

Controls verification of the FTP server's TLS certificate chain.

Certificate-chain verification is separate from hostname matching and public-key pinning. Hostname matching, when required, is enforced independently even when this property is false. TlsPinSet supplements rather than replaces normal certificate verification.

The hostname used for the TLS connection is also used for Server Name Indication (SNI) and certificate hostname comparison.

Set to true to request that the next applicable upload or download resume from existing content instead of starting over. Unrelated FTP commands do not consume the setting. The next applicable transfer consumes it and automatically resets it to false.

For a resumed upload, Chilkat obtains the existing remote size, begins reading the local file at that offset, and appends the remaining bytes. For a resumed download to a local file, Chilkat uses the existing local size as the REST offset before retrieving the remaining remote bytes.

Resume requires compatible server support and a correct partial local or remote file. The application should verify that the existing content belongs to the same file version before resuming.

Contains the in-memory FTP session log collected while KeepSessionLog is true. The log includes protocol commands and server replies and is useful for troubleshooting. Passwords and other sensitive information may appear; handle the text accordingly.

Specifies the hostname or IP address of the SOCKS proxy. It is used only when SocksVersion is 4 or 5.

Specifies the password for SOCKS5 username/password authentication. It is ignored for SOCKS4, which has no password-authentication field.

Specifies the SOCKS proxy port. The default is 1080. It is used only when SocksVersion is 4 or 5.

Specifies the SOCKS user identifier. SOCKS5 may use it with password authentication; SOCKS4 sends it as the protocol user ID. It is used only when SocksVersion is 4 or 5.

Selects SOCKS proxy usage.

Specifies the socket receive-buffer size. The default is 4194304 bytes. Normally this property should remain unchanged.

When download throughput is unexpectedly low, testing a larger value may help. Values should generally be multiples of 4096.

Specifies the socket send-buffer size. The default is 262144 bytes. Normally this property should remain unchanged.

When upload throughput is unexpectedly low, testing values such as 524288 or 1048576 may help. Values should generally be multiples of 4096.

Set to true to use implicit FTP over TLS. TLS begins immediately after the TCP connection is established, before the FTP greeting is received. Port 990 is conventionally used for implicit FTPS.

This property has priority over AuthTls and AuthSsl. If Ssl is true, implicit TLS is used even when either explicit-TLS property is also true. ConnectOnly performs the implicit TLS handshake but does not send USER or PASS.

Restricts the cipher suites and selected TLS security requirements offered for FTP TLS connections.

Leave this property empty to allow all cipher suites implemented by the installed Chilkat version. To restrict negotiation, provide a comma-separated list in preference order, for example:

TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384, TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256

The server chooses from the cipher suites offered by the client; the client cannot force a suite the server does not support.

The list may also contain these policy keywords:

• rsa1024 or rsa2048 to require a minimum RSA server-key size.
• secure-renegotiation to require secure TLS renegotiation.
• best-practices to use the security policy recommended by the installed Chilkat version.

Legacy keywords such as aes256-cbc, aes128-cbc, 3des-cbc, and rc4 remain recognized for compatibility, but explicitly listing acceptable suites is preferred.

Selects the TLS protocol version or minimum version allowed for secure FTP connections.

The complete list of accepted values is:

default
TLS 1.3
TLS 1.2
TLS 1.1
TLS 1.0
SSL 3.0
TLS 1.3 or higher
TLS 1.2 or higher
TLS 1.1 or higher
TLS 1.0 or higher

The default is default, which allows Chilkat to negotiate a protocol supported by both client and server. A minimum-version setting is generally more interoperable than requiring one exact version.

Indicates whether the FTP server certificate chain was successfully verified for the current or most recent TLS connection.

This property reports certificate-chain verification only. It does not report hostname matching or public-key pinning. If hostname matching or TlsPinSet pinning is required and the check fails, the TLS connection itself fails.

Controls whether download synchronization creates empty remote directories on the local filesystem. The default is true. When false, a local directory is created only when it is needed to contain a downloaded file.

Specifies a semicolon-separated list of case-insensitive wildcard patterns for files that are eligible for synchronization and tree operations. For example: *.xml;*.txt;*.csv.

When nonempty, a file must match at least one pattern. This filter applies to synchronization methods and also to DownloadTree and DirTreeXml.

Specifies a semicolon-separated list of case-insensitive wildcard patterns for directories that synchronization methods are allowed to enter. For example: src;data_*;reports. When nonempty, a directory must match at least one pattern before its contents are traversed.

Specifies a semicolon-separated list of case-insensitive wildcard patterns for files that must be excluded from synchronization and tree operations. For example: *.tmp;*.bak;~*.

Exclusion is applied in addition to SyncMustMatch. This filter also applies to DownloadTree and DirTreeXml.

Specifies a semicolon-separated list of case-insensitive wildcard patterns for directories that synchronization methods must not enter. For example: .git;temp;archive_*. Exclusion is applied in addition to SyncMustMatchDir.

Contains the preview produced by SyncRemoteTree2 when ARG4 is true. Each CRLF-delimited line is an absolute local path that would be uploaded if preview mode were disabled.

The value is replaced by each preview operation and is cleared by a subsequent non-preview synchronization operation.

Contains the cipher suite negotiated for the current or most recent successful TLS connection, such as TLS_AES_256_GCM_SHA384. It is empty before a TLS session has been established or after a failed attempt that produced no negotiated suite.

Specifies one or more expected Subject Public Key Info (SPKI) fingerprints for TLS public-key pinning. If none of the configured pins matches the server certificate, the TLS handshake fails.

Pinning supplements normal certificate-chain verification; it does not replace it. A matching pin does not make an expired or otherwise invalid certificate acceptable. When a pin set is configured, pin matching is enforced even if RequireSslCertVerify is false.

The format is:

hashAlgorithm, encoding, fingerprint1, fingerprint2, ...

Example:

sha256, base64, lKg1SIqyhPSK19tlPbjl8s02yChsVTDklQpkMCHvsTE=

Supported hash algorithms include sha1, sha256, sha384, sha512, md2, md5, haval, ripemd128, ripemd160, ripemd256, and ripemd320. Supported encodings include base64, hex, and other Chilkat-supported binary encodings.

Contains the protocol version negotiated for the current or most recent successful TLS connection, such as TLS 1.2 or TLS 1.3. It is empty when no TLS session has been established.

Provides a comma-separated list of compatibility options for uncommon platform or server requirements. The default is empty and should normally remain empty.

Returns the current average upload rate in bytes per second. The value is updated during synchronous and asynchronous uploads and describes the upload in progress or the most recently completed upload. A subsequent download does not clear the retained upload rate.

Controls whether passive data connections first use EPSV instead of PASV. The default is false. This property has no effect when Passive is false.

If EPSV is rejected, Chilkat automatically retries the data connection using PASV. The rejection does not disable EPSV for the remainder of the session, so a later passive data connection may try EPSV again.

AutoSetUseEpsv can change this property automatically when server capabilities are examined.

Specifies the FTP login name. The default is anonymous. Set it to an empty string to have Connect establish the connection without performing authentication; authentication may then be handled separately with LoginAfterConnectOnly.

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

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

Appends the contents of the local file at localFilePath to the remote file at remoteFilePath. If the remote file does not exist, server behavior may be equivalent to creating it. Both arguments are paths in their respective local and remote filesystems.

Returns true for success, false for failure.

Creates an asynchronous task to call the AppendFile method with the arguments provided.

Returns nil on failure

Appends the bytes in the BinData object bd to the remote file at remoteFilename. No text encoding or line-ending conversion is performed.

Returns true for success, false for failure.

Creates an asynchronous task to call the AppendFileBd method with the arguments provided.

Returns nil on failure

Appends the bytes in content to the remote file named by remoteFilename. No character encoding or line-ending conversion is performed.

Returns true for success, false for failure.

Creates an asynchronous task to call the AppendFileFromBinaryData method with the arguments provided.

Returns nil on failure

Encodes the text in textData using the character encoding named by charset and appends the resulting bytes to the remote file at remoteFilename.

This method controls the encoding of the file content. The encoding used for the remote filename itself is controlled separately by CommandCharset.

Returns true for success, false for failure.

Creates an asynchronous task to call the AppendFileFromTextData method with the arguments provided.

Returns nil on failure

Encodes the text in the StringBuilder sb using the charset named by charset and appends the resulting bytes to the remote file at remoteFilename.

Returns true for success, false for failure.

Creates an asynchronous task to call the AppendFileSb method with the arguments provided.

Returns nil on failure

Changes the current working directory on the FTP server to remoteDirPath. A relative path is resolved from the current remote directory; an absolute path is interpreted according to the server's path syntax.

Some servers accept a multi-level path in one CWD command, while others require one directory level at a time.

Returns true for success, false for failure.

Creates an asynchronous task to call the ChangeRemoteDir method with the arguments provided.

Returns nil on failure

Tests whether the FTP control session is still connected and authenticated. The method may send NOOP so the result reflects the server's response rather than only the local socket state.

Returns true for success, false for failure.

Creates an asynchronous task to call the CheckConnection method with the arguments provided.

Returns nil on failure

Requests that an explicit-FTPS control connection return to clear text after authentication. Data connections may remain protected according to DataProtection.

Returns true for success, false for failure.

Creates an asynchronous task to call the ClearControlChannel method with the arguments provided.

Returns nil on failure

Clears the cached listing for the current remote directory. The next call to GetDirCount or another indexed listing method retrieves a fresh listing from the server. The cache is also invalidated when the current directory or ListPattern changes.

Clears the in-memory FTP protocol log collected while KeepSessionLog is enabled.

Connects to the server specified by Hostname and Port, negotiates any configured proxy and TLS layer, receives the FTP greeting, and authenticates using Username, Password, and Account.

For implicit or explicit FTPS, TLS is established before USER and PASS are sent. During connection setup, Chilkat sends PBSZ and PROT as required by DataProtection. If the server replies with 530 Please login with USER and PASS, Chilkat authenticates and automatically retries those commands. Rejection of a required PBSZ or PROT command causes the connection attempt to fail.

A failed connection attempt does not leave an underlying plain FTP connection open. To separate connection establishment from authentication, call ConnectOnly followed by LoginAfterConnectOnly.

Returns true for success, false for failure.

Creates an asynchronous task to call the Connect method with the arguments provided.

Returns nil on failure

Establishes the configured proxy and TCP connection, performs any configured implicit or explicit TLS setup, and receives the FTP server greeting, but does not send USER or PASS. Complete authentication by calling LoginAfterConnectOnly.

With implicit FTPS, the TLS handshake occurs immediately after the TCP connection is established and before the greeting is received. With explicit FTPS, Chilkat first receives the greeting, sends AUTH TLS or AUTH SSL, and then performs the TLS handshake.

Returns true for success, false for failure.

Creates an asynchronous task to call the ConnectOnly method with the arguments provided.

Returns nil on failure

Upgrades an already-connected clear FTP control channel to TLS. This method is intended for a manually staged connection created with ConnectOnly.

Do not call it when AuthTls or AuthSsl was enabled before connecting; those properties perform the upgrade automatically.

Returns true for success, false for failure.

Creates an asynchronous task to call the ConvertToTls method with the arguments provided.

Returns nil on failure

Creates and returns a textual upload plan for the local directory at localDir. The plan lists the operations that PutTree would perform and can later be executed by PutPlan.

Returns nil on failure

Creates an asynchronous task to call the CreatePlan method with the arguments provided.

Returns nil on failure

Creates the remote directory at remoteDirPath by sending the server's directory-creation command. The path is interpreted relative to the current remote directory unless the server recognizes it as absolute.

If the directory already exists, the server commonly returns an error and the method fails.

Returns true for success, false for failure.

Creates an asynchronous task to call the CreateRemoteDir method with the arguments provided.

Returns nil on failure

Deletes files in the current remote directory whose names match the wildcard pattern in remotePattern. The method returns the number deleted, or -1 if the operation fails.

* matches zero or more characters. Matching details may depend on the server because the remote listing operation is server-side.

Creates an asynchronous task to call the DeleteMatching method with the arguments provided.

Returns nil on failure

Deletes the remote file at remoteFilePath. The path may be relative to the current remote directory or absolute according to the server's path syntax.

Returns true for success, false for failure.

Creates an asynchronous task to call the DeleteRemoteFile method with the arguments provided.

Returns nil on failure

Recursively deletes the files and subdirectories beneath the current remote directory and then removes directories as they become empty.

Returns true for success, false for failure.

Creates an asynchronous task to call the DeleteTree method with the arguments provided.

Returns nil on failure

Returns an XML representation of the complete remote directory tree rooted at the current remote directory. Traversal is affected by SyncMustMatch, SyncMustNotMatch, SyncMustMatchDir, and SyncMustNotMatchDir.

This method retrieves metadata; it does not download file content.

Returns nil on failure

Creates an asynchronous task to call the DirTreeXml method with the arguments provided.

Returns nil on failure

Ends the FTP session and closes the control connection. When possible, Chilkat sends the normal FTP quit command before closing the socket.

Returns true for success, false for failure.

Creates an asynchronous task to call the Disconnect method with the arguments provided.

Returns nil on failure

Downloads all selected files and subdirectories beneath the current remote directory and recreates the tree under the local directory at localRoot.

The file and directory filters in SyncMustMatch, SyncMustNotMatch, SyncMustMatchDir, and SyncMustNotMatchDir apply. Use SetOldestDateStr to exclude files older than a chosen date.

Returns true for success, false for failure.

Creates an asynchronous task to call the DownloadTree method with the arguments provided.

Returns nil on failure

Sends FEAT and returns the server's multiline capability reply. A server may return an error when the command is unsupported. Chilkat also performs capability discovery automatically when AutoFeat is enabled.

A successful explicit call performs the same capability processing as automatic FEAT. It can update HasModeZ, listing-extension detection, UTF-8 handling through AutoOptsUtf8, and UseEpsv through AutoSetUseEpsv, even when AutoFeat is false.

Returns nil on failure

Creates an asynchronous task to call the Feat method with the arguments provided.

Returns nil on failure

Returns the creation time for the file or directory named by filename in the current remote directory as an RFC 822 date-time string, such as Fri, 21 Nov 1997 09:55:06 -0600.

filename must be a name, not a path. Set the current remote directory first, and ensure ListPattern matches the name so the item is present in the cached listing.

Returns nil on failure

Creates an asynchronous task to call the GetCreateTimeByNameStr method with the arguments provided.

Returns nil on failure

Returns the creation time for cached directory-listing entry index as an RFC 822 date-time string, such as Fri, 21 Nov 1997 09:55:06 -0600. index is a zero-based index from 0 through one less than GetDirCount. Creation-time availability depends on the server and listing format.

Returns nil on failure

Creates an asynchronous task to call the GetCreateTimeStr method with the arguments provided.

Returns nil on failure

Returns the current working directory reported by the FTP server, normally by using the PWD command.

Returns nil on failure

Creates an asynchronous task to call the GetCurrentRemoteDir method with the arguments provided.

Returns nil on failure

Returns the number of files and directories in the cached listing of the current remote directory after applying the case-insensitive ListPattern. On the first call, Chilkat obtains and caches the full directory listing and then applies the pattern locally. Repeated indexed listing calls use the cache until it is invalidated. Call ClearDirCache to force a refresh. Returns -1 if the listing cannot be obtained or parsed.

Creates an asynchronous task to call the GetDirCount method with the arguments provided.

Returns nil on failure

Downloads the remote file at remoteFilePath to the local filesystem path at localFilePath. The local file is created or replaced according to the normal download behavior.

Use RestartNext immediately before this call to request resume of an existing partial file. ReadTimeout controls data-channel inactivity.

Returns true for success, false for failure.

Creates an asynchronous task to call the GetFile method with the arguments provided.

Returns nil on failure

Downloads the remote file at remoteFilePath and places its bytes in the BinData object in binData. No text decoding or line-ending conversion is performed.

Returns true for success, false for failure.

Creates an asynchronous task to call the GetFileBd method with the arguments provided.

Returns nil on failure

Returns the name of cached directory-listing entry index. index is a zero-based index from 0 through one less than GetDirCount. The returned value is the name from the listing, not necessarily a full remote path.

Returns nil on failure

Creates an asynchronous task to call the GetFilename method with the arguments provided.

Returns nil on failure

Downloads the remote file at remoteFilePath, decodes its bytes using the charset named by charset, and places the resulting text in the StringBuilder in sb.

Returns true for success, false for failure.

Creates an asynchronous task to call the GetFileSb method with the arguments provided.

Returns nil on failure

Downloads the remote file at remoteFilePath and writes its bytes to the Stream in toStream.

For a synchronous call, toStream must be configured with a destination sink before the method begins. For an asynchronous call, application code may read from the stream while the background download produces data.

Returns true for success, false for failure.

Creates an asynchronous task to call the GetFileToStream method with the arguments provided.

Returns nil on failure

Returns the group name or identifier for cached directory-listing entry index. The value is empty when the server does not provide group metadata.

Returns nil on failure

Creates an asynchronous task to call the GetGroup method with the arguments provided.

Returns nil on failure

Returns true when cached directory-listing entry index is identified as a directory. index is a zero-based index into the current cached listing.

Creates an asynchronous task to call the GetIsDirectory method with the arguments provided.

Returns nil on failure

Returns true when cached directory-listing entry index is identified as a symbolic link. This information is available only when the server's listing format reports it.

Creates an asynchronous task to call the GetIsSymbolicLink method with the arguments provided.

Returns nil on failure

Copies JSON details from the most recent method call into the JsonObject in json. Only methods that produce structured supplemental information populate this data; otherwise the object may remain empty. Call this method immediately after the operation whose details are needed.

Returns true for success, false for failure.

Returns the last-modified time for the item named by filename in the current remote directory as an RFC 822 date-time string, such as Fri, 21 Nov 1997 09:55:06 -0600.

filename must be a name, not a path. Set the current remote directory first, and ensure ListPattern matches the name.

Returns nil on failure

Creates an asynchronous task to call the GetLastModifiedTimeByNameStr method with the arguments provided.

Returns nil on failure

Returns the last-modified time for cached directory-listing entry index as an RFC 822 date-time string, such as Fri, 21 Nov 1997 09:55:06 -0600. index is a zero-based index into the current cached listing.

Returns nil on failure

Creates an asynchronous task to call the GetLastModifiedTimeStr method with the arguments provided.

Returns nil on failure

Returns the owner name or identifier for cached directory-listing entry index. The value is empty when the server does not provide owner metadata.

Returns nil on failure

Creates an asynchronous task to call the GetOwner method with the arguments provided.

Returns nil on failure

Returns the permissions or status string for cached directory-listing entry index. The value is empty when the server provides no such metadata. Use GetPermType to determine how to interpret the result.

Returns nil on failure

Creates an asynchronous task to call the GetPermissions method with the arguments provided.

Returns nil on failure

Returns the format identifier for the permissions string available for cached listing entry index. The value is empty when no permissions are available.

Use GetPermissions to obtain the corresponding value.

Returns nil on failure

Creates an asynchronous task to call the GetPermType method with the arguments provided.

Returns nil on failure

Downloads the remote file at remoteFilename and returns its bytes. No character decoding or line-ending conversion is performed.

Returns nil on failure

Creates an asynchronous task to call the GetRemoteFileBinaryData method with the arguments provided.

Returns nil on failure

Downloads the remote file at remoteFilename, decodes its bytes using the character encoding named by charset, and returns the resulting text.

Returns nil on failure

Creates an asynchronous task to call the GetRemoteFileTextC method with the arguments provided.

Returns nil on failure

Downloads the remote file at remoteFilename and returns its contents decoded using the ANSI character encoding. Use GetRemoteFileTextC when the file uses UTF-8 or another explicitly known encoding.

Returns nil on failure

Creates an asynchronous task to call the GetRemoteFileTextData method with the arguments provided.

Returns nil on failure

Loads into the Cert object in cert the certificate presented by the FTP server during the current or most recent TLS connection.

Returns true for success, false for failure.

Returns the size in bytes of cached directory-listing entry index as a 32-bit integer. Use GetSize64 for large files. A negative value indicates that the size is unavailable or the operation failed.

Creates an asynchronous task to call the GetSize method with the arguments provided.

Returns nil on failure

Returns the size in bytes of cached directory-listing entry index as a 64-bit integer. Returns -1 when the size is unavailable or the operation fails.

Creates an asynchronous task to call the GetSize64 method with the arguments provided.

Returns nil on failure

Returns the size in bytes of the file named by filename in the current remote directory as a 32-bit integer. Returns -1 when the file is not found or the size cannot be obtained. Use GetSizeByName64 for large files.

filename must be a name, not a path. Set the current remote directory first, and ensure ListPattern matches the name.

Creates an asynchronous task to call the GetSizeByName method with the arguments provided.

Returns nil on failure

Returns the size in bytes of the file named by filename in the current remote directory as a 64-bit integer. Returns -1 when the file is not found or the size cannot be obtained.

filename must be a name, not a path. Set the current remote directory first, and ensure ListPattern matches the name.

Creates an asynchronous task to call the GetSizeByName64 method with the arguments provided.

Returns nil on failure

Returns the size in bytes of cached directory-listing entry index as a decimal string. This form avoids integer-size limits in languages without a convenient 64-bit type.

Returns nil on failure

Creates an asynchronous task to call the GetSizeStr method with the arguments provided.

Returns nil on failure

Returns the size in bytes of the file named by filename in the current remote directory as a decimal string. This form avoids language-specific integer limits.

filename must be a name, not a path. Set the current remote directory first, and ensure ListPattern matches the name.

Returns nil on failure

Creates an asynchronous task to call the GetSizeStrByName method with the arguments provided.

Returns nil on failure

Appends to the StringTable in strTable the relative paths affected by the most recent synchronization operation. Existing entries in strTable are preserved. The appended paths include files uploaded, downloaded, or deleted by SyncDeleteRemote, SyncLocalDir, SyncLocalTree, SyncRemoteTree, or SyncRemoteTree2.

Sends a directory-listing request for pattern and returns the server's raw textual listing. pattern may be a wildcard pattern or other argument accepted by the server.

The format of LIST output is server-specific; use the indexed listing methods or GetXmlDirListing when parsed metadata is preferred.

Returns nil on failure

Creates an asynchronous task to call the GetTextDirListing method with the arguments provided.

Returns nil on failure

Retrieves a directory listing for pattern and returns the parsed entries as XML. pattern may be a wildcard pattern accepted by the server. The metadata available depends on whether the server provides MLSD facts or a parseable legacy listing.

Returns nil on failure

Creates an asynchronous task to call the GetXmlDirListing method with the arguments provided.

Returns nil on failure

Uploads the local file at localPath to the remote path at remotePath as a sequence of append operations, each containing up to chunkSize bytes.

This method addresses a specific FTP failure mode: during one very long data transfer, the control connection is idle and may be silently dropped by a firewall, NAT device, or server timeout. Completing the upload as multiple shorter transfers periodically uses the control channel.

chunkSize is the in-memory chunk size. Larger chunks reduce FTP command overhead but consume more memory and leave the control channel idle longer; smaller chunks have the opposite tradeoff.

Returns true for success, false for failure.

Creates an asynchronous task to call the LargeFileUpload method with the arguments provided.

Returns nil on failure

Loads the original caller object associated with the asynchronous Task in task. This is an internal support method for Chilkat's task infrastructure and is not normally needed by application code.

Returns true for success, false for failure.

Authenticates an FTP session previously established by ConnectOnly, using Username, Password, and Account. When TLS is configured, the secure connection has already been established before this method sends USER and PASS.

Together, ConnectOnly and this method perform the connection and login stages of Connect. After authentication, Chilkat performs the configured automatic capability and system queries. Set AutoFeat or AutoSyst to false to suppress those commands.

Returns true for success, false for failure.

Creates an asynchronous task to call the LoginAfterConnectOnly method with the arguments provided.

Returns nil on failure

Downloads files in the current remote directory that match remotePattern into the local directory at localDir. Subdirectories are not traversed. The method returns the number of files downloaded, or -1 on failure.

Wildcard matching is performed by the FTP server's listing command and may be case-sensitive or case-insensitive according to the remote server and filesystem.

Creates an asynchronous task to call the MGetFiles method with the arguments provided.

Returns nil on failure

Uploads each local file matching pattern to the current remote directory. pattern may include a local directory and wildcard, such as C:/data/*.txt. Subdirectories are not traversed.

The method returns the number of files uploaded, or -1 on failure.

Creates an asynchronous task to call the MPutFiles method with the arguments provided.

Returns nil on failure

Sends NLST with remoteDirPattern and returns the names in XML form. remoteDirPattern may be a pattern such as *, *.txt, or subdir/*.xml.

<nlst>
  <e>name1</e>
  <e>name2</e>
</nlst>

NLST normally returns names only; it does not provide reliable sizes, times, or permissions.

Returns nil on failure

Creates an asynchronous task to call the NlstXml method with the arguments provided.

Returns nil on failure

Sends the FTP NOOP command. This can test whether the control session is still responsive or keep an otherwise idle control connection active.

Returns true for success, false for failure.

Creates an asynchronous task to call the Noop method with the arguments provided.

Returns nil on failure

Uploads the local filesystem file at localFilePath to the remote path at remoteFilePath. The remote file is created or replaced according to server behavior.

Use RestartNext immediately before this call to request resume of an existing partial remote file. IdleTimeoutMs limits how long the upload may remain blocked without forward progress.

Returns true for success, false for failure.

Creates an asynchronous task to call the PutFile method with the arguments provided.

Returns nil on failure

Uploads the bytes contained in the BinData object in binData to the remote path at remoteFilePath. No character encoding or line-ending conversion is performed.

Returns true for success, false for failure.

Creates an asynchronous task to call the PutFileBd method with the arguments provided.

Returns nil on failure

Creates or replaces the remote file at remoteFilename with the bytes in content. No character encoding or line-ending conversion is performed.

Returns true for success, false for failure.

Creates an asynchronous task to call the PutFileFromBinaryData method with the arguments provided.

Returns nil on failure

Encodes the text in textData using the character encoding named by charset and uploads the resulting bytes to the remote file at remoteFilename.

charset controls the file content encoding. Remote filename encoding is controlled separately by CommandCharset.

Returns true for success, false for failure.

Creates an asynchronous task to call the PutFileFromTextData method with the arguments provided.

Returns nil on failure

Encodes the text in the StringBuilder sb using the charset named by charset and uploads it to the remote path at remoteFilePath. When includeBom is true, a byte-order mark is included when the selected encoding defines one.

Returns true for success, false for failure.

Creates an asynchronous task to call the PutFileSb method with the arguments provided.

Returns nil on failure

Executes the upload plan in plan. alreadyDoneFilename is the local path of a completion log; each successful plan operation is recorded there.

To resume an interrupted plan, call this method again with the same plan and log path. Operations already recorded as complete are skipped.

Returns true for success, false for failure.

Creates an asynchronous task to call the PutPlan method with the arguments provided.

Returns nil on failure

Uploads the local directory tree rooted at localDir into the current remote directory, creating remote subdirectories as needed. The contents of localDir become children of the current remote directory.

Returns true for success, false for failure.

Creates an asynchronous task to call the PutTree method with the arguments provided.

Returns nil on failure

Sends the raw FTP command text in cmd to the server. Use this for a command not otherwise exposed by the API.

cmd should contain the command and parameters but not the terminating CRLF. The method does not parse command-specific semantics.

Returns true for success, false for failure.

Creates an asynchronous task to call the Quote method with the arguments provided.

Returns nil on failure

Removes the remote directory at remoteDirPath. FTP servers generally require the directory to be empty before it can be removed.

Returns true for success, false for failure.

Creates an asynchronous task to call the RemoveRemoteDir method with the arguments provided.

Returns nil on failure

Renames or moves a remote file or directory from existingRemoteFilePath to newRemoteFilePath using the FTP rename sequence. Include directory components in newRemoteFilePath to move the item within the same FTP server.

Returns true for success, false for failure.

Creates an asynchronous task to call the RenameRemoteFile method with the arguments provided.

Returns nil on failure

Sends the raw FTP command in cmd and returns the complete server reply. cmd should not include the terminating CRLF.

The command text is sent as UTF-8. CommandCharset is not applied to this method. Use this method when a raw command or its reply text is required directly.

Returns nil on failure

Creates an asynchronous task to call the SendCommand method with the arguments provided.

Returns nil on failure

Enables MODE Z compression for subsequent data connections. Call this after connecting and only when HasModeZ is true. Uploads, downloads, and directory listings are then transferred through a DEFLATE-compressed stream.

Returns true for success, false for failure.

Creates an asynchronous task to call the SetModeZ method with the arguments provided.

Returns nil on failure

Sets the oldest remote modification time eligible for the next DownloadTree operation. oldestDateTimeStr is an RFC 822 date-time string, such as Fri, 21 Nov 1997 09:55:06 -0600. Files older than this value are skipped.

Enables or disables a named compatibility option. option identifies the option; prefix the name with No- to disable it.

The recognized option Microsoft-TLS-1.2-Workaround changes data-channel TLS behavior for compatibility with an old Microsoft FTP server defect. It weakens protocol selection and should be used only for the affected legacy server.

Returns true for success, false for failure.

Sets the last-modified time of the remote file at remoteFilename. dateTimeStr is an RFC 822 date-time string, such as Fri, 21 Nov 1997 09:55:06 -0600.

FTP has no universally supported standard command for changing a file timestamp; success depends on server extensions and permissions.

Returns true for success, false for failure.

Creates an asynchronous task to call the SetRemoteFileDateTimeStr method with the arguments provided.

Returns nil on failure

Sets the last-modified time of the remote file at remoteFilename from the DateTime object in dt.

FTP has no universally supported standard command for changing a file timestamp; success depends on server extensions and permissions.

Returns true for success, false for failure.

Creates an asynchronous task to call the SetRemoteFileDt method with the arguments provided.

Returns nil on failure

Copies the password from the SecureString in password for subsequent FTP authentication. This avoids exposing the password as an ordinary immutable language string. It is equivalent to setting Password for login behavior.

Returns true for success, false for failure.

Adds a required match against the FTP server certificate. reqName selects the certificate field and reqValue specifies the required value. Supported field names include SubjectDN, SubjectCN, IssuerDN, IssuerCN, and SAN. Wildcards may be used in reqValue.

The TLS connection is rejected when the presented certificate does not satisfy the requirement.

Configures the Cert in cert as the client certificate for FTPS servers that request mutual TLS authentication. The certificate must have access to its private key.

Returns true for success, false for failure.

Configures a client certificate and private key from PEM data or a PEM file. pemDataOrFilename may contain the PEM text or the local filesystem path of a PEM file. pemPassword is the private-key password, or an empty string when the key is not encrypted.

Returns true for success, false for failure.

Loads a client certificate and private key from the local PFX/P12 file at pfxFilename. pfxPassword is the file password. The certificate is used when the FTPS server requests mutual TLS authentication.

Returns true for success, false for failure.

Sets the FTP representation type to ASCII for subsequent transfers. In ASCII mode, the FTP endpoints may translate line endings, and CrlfMode can apply additional conversion on downloads.

Returns true for success, false for failure.

Creates an asynchronous task to call the SetTypeAscii method with the arguments provided.

Returns nil on failure

Sets the FTP representation type to binary (TYPE I) for subsequent transfers. Binary mode preserves file bytes and is the appropriate default for nearly all modern file types.

Returns true for success, false for failure.

Creates an asynchronous task to call the SetTypeBinary method with the arguments provided.

Returns nil on failure

Sends a server-specific SITE command. siteCommand contains the text following SITE, for example RECFM=FB LRECL=600.

SITE subcommands are defined by the server, not by the FTP standard, and may require special permissions.

Returns true for success, false for failure.

Creates an asynchronous task to call the Site method with the arguments provided.

Returns nil on failure

Blocks the calling thread for millisec milliseconds. This is a utility method and performs no FTP network operation.

Sends the FTP STAT command and returns the server's reply. Depending on the server and session state, the reply may contain status information or a directory listing.

Returns nil on failure

Creates an asynchronous task to call the Stat method with the arguments provided.

Returns nil on failure

Recursively compares the remote tree rooted at the current remote directory with the local tree rooted at localRoot and deletes remote files that have no corresponding local file. The synchronization file and directory filters apply. Empty remote directories are not deleted.

Use GetSyncedFiles after the call to obtain the relative paths deleted.

Returns true for success, false for failure.

Creates an asynchronous task to call the SyncDeleteRemote method with the arguments provided.

Returns nil on failure

Synchronizes files from the current remote directory into the local directory at localRoot without descending into subdirectories. mode selects the same download mode documented for SyncLocalTree. Use GetSyncedFiles afterward to obtain the affected relative paths.

Returns true for success, false for failure.

Creates an asynchronous task to call the SyncLocalDir method with the arguments provided.

Returns nil on failure

Synchronizes the remote tree rooted at the current remote directory into the local directory at localRoot. mode selects which files are downloaded or deleted.

The synchronization filters apply, and GetSyncedFiles returns the relative paths affected by the operation.

Returns true for success, false for failure.

Creates an asynchronous task to call the SyncLocalTree method with the arguments provided.

Returns nil on failure

Synchronizes the local tree rooted at localRoot into the current remote directory. mode selects which files are uploaded.

The synchronization filters apply, and GetSyncedFiles returns the relative paths uploaded.

Returns true for success, false for failure.

Creates an asynchronous task to call the SyncRemoteTree method with the arguments provided.

Returns nil on failure

Provides the upload synchronization behavior of SyncRemoteTree with traversal and preview controls. localDirPath is the local root, mode is the synchronization mode, bDescend controls whether subdirectories are traversed, and bPreviewOnly selects preview-only mode. The file and directory synchronization filters apply in both normal and preview operation.

When bPreviewOnly is true, files are not uploaded and the absolute candidate file paths are placed in SyncPreview. Required remote directories may still be created during the preview.

Returns true for success, false for failure.

Creates an asynchronous task to call the SyncRemoteTree2 method with the arguments provided.

Returns nil on failure

Sends SYST and returns the server's operating-system type reply. Chilkat can use this information when interpreting legacy directory listings.

Returns nil on failure

Creates an asynchronous task to call the Syst method with the arguments provided.

Returns nil on failure

Deprecated. Returns the number of bytes received during the current FTP download as a 32-bit unsigned integer. The value is updated while the transfer is running. Use CurBytesReceived instead.

Deprecated. Returns the number of bytes received during the current FTP download as a 64-bit integer. The value is updated while the transfer is running. Use CurBytesReceived64 instead.

Deprecated. Returns the number of bytes sent during the current FTP upload as a 32-bit unsigned integer. The value is updated while the transfer is running. Use CurBytesSent instead.

Deprecated. Returns the number of bytes sent during the current FTP upload as a 64-bit integer. The value is updated while the transfer is running. Use CurBytesSent64 instead.

Deprecated. Tries the supported traditional FTP-proxy login sequences and returns the first successful ProxyMethod value. Returns 0 when none succeeds and -1 when the test cannot be completed.

Creates an asynchronous task to call the DetermineProxyMethod method with the arguments provided.

Returns nil on failure

Deprecated. Tests combinations of Ssl, AuthTls, AuthSsl, Port, Passive, and PassiveUseHostAddr by attempting a directory listing, then returns an XML report.

The method performs multiple network attempts and can take significant time. Prefer configuring the connection explicitly from the server's documented FTP/FTPS settings.

Returns nil on failure

Creates an asynchronous task to call the DetermineSettings method with the arguments provided.

Returns nil on failure

Deprecated. Returns a new DateTime containing the creation time for cached directory-listing entry index. Use GetCreateTimeStr when a string result is preferred. index is a zero-based index from 0 through one less than GetDirCount.

Returns nil on failure

Creates an asynchronous task to call the GetCreateDt method with the arguments provided.

Returns nil on failure

Deprecated. Returns a new DateTime containing the creation time for the file or directory named by filename in the current remote directory. Use GetCreateTimeByNameStr when a string result is preferred.

filename must be a name, not a path. Set the current remote directory first, and ensure ListPattern matches the name so the item is present in the cached listing.

Returns nil on failure

Creates an asynchronous task to call the GetCreateDtByName method with the arguments provided.

Returns nil on failure

Deprecated. Returns a new DateTime containing the last-modified time for cached directory-listing entry index. Use GetLastModifiedTimeStr when a string result is preferred.

Returns nil on failure

Creates an asynchronous task to call the GetLastModDt method with the arguments provided.

Returns nil on failure

Deprecated. Returns a new DateTime containing the last-modified time for the item named by filename in the current remote directory. Use GetLastModifiedTimeByNameStr when a string result is preferred.

filename must be a name, not a path. Set the current remote directory first, and ensure ListPattern matches the name.

Returns nil on failure

Creates an asynchronous task to call the GetLastModDtByName method with the arguments provided.

Returns nil on failure

Deprecated. Returns a new Cert containing the certificate presented by the FTP server during the current or most recent TLS connection. Use GetServerCert instead.

Returns nil on failure