Ftp2 C Reference Documentation

Ftp2

Current Version: 9.5.0.75

Commercial File Transfer Protocol (FTP) Component.

Create/Dispose

HCkFtp2 instance = CkFtp2_Create();
// ...
CkFtp2_Dispose(instance);
HCkFtp2 CkFtp2_Create(void);

Creates an instance of the HCkFtp2 object and returns a handle ("void *" pointer). The handle is passed in the 1st argument for the functions listed on this page.

void CkFtp2_Dispose(HCkFtp2 handle);

Objects created by calling CkFtp2_Create must be freed by calling this method. A memory leak occurs if a handle is not disposed by calling this function. Also, any handle returned by a Chilkat "C" function must also be freed by the application by calling the appropriate Dispose method, such as CkFtp2_Dispose.

Callback Functions

Callback Functions introduced in Chilkat v9.5.0.56
void CkFtp2_setAbortCheck(HCkFtp2 cHandle, BOOL (*fnAbortCheck)(void));

Provides the opportunity for a method call to be aborted. If TRUE is returned, the operation in progress is aborted. Return FALSE to allow the current method call to continue. This callback function is called periodically based on the value of the HeartbeatMs property. (If HeartbeatMs is 0, then no callbacks are made.) As an example, to make 5 AbortCheck callbacks per second, set the HeartbeatMs property equal to 200.

void CkFtp2_setPercentDone(HCkFtp2 cHandle, BOOL (*fnPercentDone)(int pctDone));

Provides the percentage completed for any method that involves network communications or time-consuming processing (assuming it is a method where a percentage completion can be measured). This callback is only called when it is possible to know a percentage completion, and when it makes sense to express the operation as a percentage completed. The pctDone argument will have a value from 1 to 100. For methods that complete very quickly, the number of PercentDone callbacks will vary, but the final callback should have a value of 100. For long running operations, no more than one callback per percentage point will occur (for example: 1, 2, 3, ... 98, 99, 100).

This callback counts as an AbortCheck callback, and takes the place of the AbortCheck event when it fires.

The return value indicates whether the method call should be aborted, or whether it should proceed. Return TRUE to abort, and FALSE to proceed.

void CkFtp2_setProgressInfo(HCkFtp2 cHandle, void (*fnProgressInfo)(const char *name, const char *value));

This is a general callback that provides name/value information about what is happening at certain points during a method call. To see the information provided in ProgressInfo callbacks, if any, write code to handle this event and log the name/value pairs. Most are self-explanatory.

void CkFtp2_setTaskCompleted(HCkFtp2 cHandle, void (*fnTaskCompleted)(HCkTask hTask));

Called in the background thread when an asynchronous task completes. (Note: When an async method is running, all callbacks are in the background thread.)

Properties

AbortCurrent
BOOL CkFtp2_getAbortCurrent(HCkFtp2 cHandle);
void CkFtp2_putAbortCurrent(HCkFtp2 cHandle, BOOL newVal);
Introduced in version 9.5.0.58

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

top
Account
void CkFtp2_getAccount(HCkFtp2 cHandle, HCkString retval);
void CkFtp2_putAccount(HCkFtp2 cHandle, const char *newVal);
const char *CkFtp2_account(HCkFtp2 cHandle);

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

top
ActivePortRangeEnd
int CkFtp2_getActivePortRangeEnd(HCkFtp2 cHandle);
void CkFtp2_putActivePortRangeEnd(HCkFtp2 cHandle, int newVal);

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 and Examples
top
ActivePortRangeStart
int CkFtp2_getActivePortRangeStart(HCkFtp2 cHandle);
void CkFtp2_putActivePortRangeStart(HCkFtp2 cHandle, int newVal);

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

More Information and Examples
top
AllocateSize
unsigned long CkFtp2_getAllocateSize(HCkFtp2 cHandle);
void CkFtp2_putAllocateSize(HCkFtp2 cHandle, unsigned long newVal);

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.

top
AllowMlsd
BOOL CkFtp2_getAllowMlsd(HCkFtp2 cHandle);
void CkFtp2_putAllowMlsd(HCkFtp2 cHandle, BOOL newVal);
Introduced in version 9.5.0.50

If TRUE, then uses the MLSD command to fetch directory listings when the FTP server supports MLSD. This property is TRUE 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.

More Information and Examples
top
AsyncBytesReceived
unsigned long CkFtp2_getAsyncBytesReceived(HCkFtp2 cHandle);

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.

top
AsyncBytesReceived64
__int64 CkFtp2_getAsyncBytesReceived64(HCkFtp2 cHandle);

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

top
AsyncBytesReceivedStr
void CkFtp2_getAsyncBytesReceivedStr(HCkFtp2 cHandle, HCkString retval);
const char *CkFtp2_asyncBytesReceivedStr(HCkFtp2 cHandle);

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.

top
AsyncBytesSent
unsigned long CkFtp2_getAsyncBytesSent(HCkFtp2 cHandle);

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.

top
AsyncBytesSent64
__int64 CkFtp2_getAsyncBytesSent64(HCkFtp2 cHandle);

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

top
AsyncBytesSentStr
void CkFtp2_getAsyncBytesSentStr(HCkFtp2 cHandle, HCkString retval);
const char *CkFtp2_asyncBytesSentStr(HCkFtp2 cHandle);

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.

top
AuthSsl
BOOL CkFtp2_getAuthSsl(HCkFtp2 cHandle);
void CkFtp2_putAuthSsl(HCkFtp2 cHandle, BOOL newVal);

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.

top
AuthTls
BOOL CkFtp2_getAuthTls(HCkFtp2 cHandle);
void CkFtp2_putAuthTls(HCkFtp2 cHandle, BOOL newVal);

Set this to TRUE 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.

top
AutoFeat
BOOL CkFtp2_getAutoFeat(HCkFtp2 cHandle);
void CkFtp2_putAutoFeat(HCkFtp2 cHandle, BOOL newVal);

When TRUE (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 FALSE to prevent the FEAT command from being sent.

top
AutoFix
BOOL CkFtp2_getAutoFix(HCkFtp2 cHandle);
void CkFtp2_putAutoFix(HCkFtp2 cHandle, BOOL newVal);

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

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

The default value of this property is TRUE.

top
AutoGetSizeForProgress
BOOL CkFtp2_getAutoGetSizeForProgress(HCkFtp2 cHandle);
void CkFtp2_putAutoGetSizeForProgress(HCkFtp2 cHandle, BOOL newVal);

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

top
AutoOptsUtf8
BOOL CkFtp2_getAutoOptsUtf8(HCkFtp2 cHandle);
void CkFtp2_putAutoOptsUtf8(HCkFtp2 cHandle, BOOL newVal);
Introduced in version 9.5.0.47

When TRUE (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 FALSE to prevent the "OPTS UTF8 ON" command from being sent.

top
AutoSetUseEpsv
BOOL CkFtp2_getAutoSetUseEpsv(HCkFtp2 cHandle);
void CkFtp2_putAutoSetUseEpsv(HCkFtp2 cHandle, BOOL newVal);
Introduced in version 9.5.0.44

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

If the AutoFeat property is TRUE, and if the AutoSetUseEpsv property is TRUE, then the FTP server's features are automatically queried when connecting. In this case, the UseEpsv property is automatically set to TRUE 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 FALSE.

top
AutoSyst
BOOL CkFtp2_getAutoSyst(HCkFtp2 cHandle);
void CkFtp2_putAutoSyst(HCkFtp2 cHandle, BOOL newVal);

When TRUE (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 FALSE.

top
AutoXcrc
BOOL CkFtp2_getAutoXcrc(HCkFtp2 cHandle);
void CkFtp2_putAutoXcrc(HCkFtp2 cHandle, BOOL newVal);

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 TRUE, 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 FALSE.

top
BandwidthThrottleDown
int CkFtp2_getBandwidthThrottleDown(HCkFtp2 cHandle);
void CkFtp2_putBandwidthThrottleDown(HCkFtp2 cHandle, int newVal);

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.

More Information and Examples
top
BandwidthThrottleUp
int CkFtp2_getBandwidthThrottleUp(HCkFtp2 cHandle);
void CkFtp2_putBandwidthThrottleUp(HCkFtp2 cHandle, int newVal);

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.

More Information and Examples
top
ClientIpAddress
void CkFtp2_getClientIpAddress(HCkFtp2 cHandle, HCkString retval);
void CkFtp2_putClientIpAddress(HCkFtp2 cHandle, const char *newVal);
const char *CkFtp2_clientIpAddress(HCkFtp2 cHandle);

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

More Information and Examples
top
CommandCharset
void CkFtp2_getCommandCharset(HCkFtp2 cHandle, HCkString retval);
void CkFtp2_putCommandCharset(HCkFtp2 cHandle, const char *newVal);
const char *CkFtp2_commandCharset(HCkFtp2 cHandle);

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

top
ConnectFailReason
int CkFtp2_getConnectFailReason(HCkFtp2 cHandle);

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.

top
ConnectTimeout
int CkFtp2_getConnectTimeout(HCkFtp2 cHandle);
void CkFtp2_putConnectTimeout(HCkFtp2 cHandle, int newVal);

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.

top
ConnectVerified
BOOL CkFtp2_getConnectVerified(HCkFtp2 cHandle);

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

top
CrlfMode
int CkFtp2_getCrlfMode(HCkFtp2 cHandle);
void CkFtp2_putCrlfMode(HCkFtp2 cHandle, int newVal);

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

top
DataProtection
void CkFtp2_getDataProtection(HCkFtp2 cHandle, HCkString retval);
void CkFtp2_putDataProtection(HCkFtp2 cHandle, const char *newVal);
const char *CkFtp2_dataProtection(HCkFtp2 cHandle);
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.

top
DebugLogFilePath
void CkFtp2_getDebugLogFilePath(HCkFtp2 cHandle, HCkString retval);
void CkFtp2_putDebugLogFilePath(HCkFtp2 cHandle, const char *newVal);
const char *CkFtp2_debugLogFilePath(HCkFtp2 cHandle);

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.

top
DirListingCharset
void CkFtp2_getDirListingCharset(HCkFtp2 cHandle, HCkString retval);
void CkFtp2_putDirListingCharset(HCkFtp2 cHandle, const char *newVal);
const char *CkFtp2_dirListingCharset(HCkFtp2 cHandle);

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

More Information and Examples
top
DownloadTransferRate
int CkFtp2_getDownloadTransferRate(HCkFtp2 cHandle);

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

top
ForcePortIpAddress
void CkFtp2_getForcePortIpAddress(HCkFtp2 cHandle, HCkString retval);
void CkFtp2_putForcePortIpAddress(HCkFtp2 cHandle, const char *newVal);
const char *CkFtp2_forcePortIpAddress(HCkFtp2 cHandle);

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.

top
Greeting
void CkFtp2_getGreeting(HCkFtp2 cHandle, HCkString retval);
const char *CkFtp2_greeting(HCkFtp2 cHandle);

The initial greeting received from the FTP server after connecting.

top
HasModeZ
BOOL CkFtp2_getHasModeZ(HCkFtp2 cHandle);

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 TRUE if the FTP2 component detects that your FTP server supports MODE Z. Otherwise it is set to FALSE.

top
HeartbeatMs
int CkFtp2_getHeartbeatMs(HCkFtp2 cHandle);
void CkFtp2_putHeartbeatMs(HCkFtp2 cHandle, int newVal);

This is the number of milliseconds between each AbortCheck event callback. The AbortCheck callback allows an application to abort any FTP operation prior to completion. If HeartbeatMs is 0, no AbortCheck event callbacks will occur. Also, AbortCheck callbacks do not occur when doing asynchronous transfers.

top
Hostname
void CkFtp2_getHostname(HCkFtp2 cHandle, HCkString retval);
void CkFtp2_putHostname(HCkFtp2 cHandle, const char *newVal);
const char *CkFtp2_hostname(HCkFtp2 cHandle);

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

top
HttpProxyAuthMethod
void CkFtp2_getHttpProxyAuthMethod(HCkFtp2 cHandle, HCkString retval);
void CkFtp2_putHttpProxyAuthMethod(HCkFtp2 cHandle, const char *newVal);
const char *CkFtp2_httpProxyAuthMethod(HCkFtp2 cHandle);

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

top
HttpProxyDomain
void CkFtp2_getHttpProxyDomain(HCkFtp2 cHandle, HCkString retval);
void CkFtp2_putHttpProxyDomain(HCkFtp2 cHandle, const char *newVal);
const char *CkFtp2_httpProxyDomain(HCkFtp2 cHandle);

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

top
HttpProxyHostname
void CkFtp2_getHttpProxyHostname(HCkFtp2 cHandle, HCkString retval);
void CkFtp2_putHttpProxyHostname(HCkFtp2 cHandle, const char *newVal);
const char *CkFtp2_httpProxyHostname(HCkFtp2 cHandle);

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

More Information and Examples
top
HttpProxyPassword
void CkFtp2_getHttpProxyPassword(HCkFtp2 cHandle, HCkString retval);
void CkFtp2_putHttpProxyPassword(HCkFtp2 cHandle, const char *newVal);
const char *CkFtp2_httpProxyPassword(HCkFtp2 cHandle);

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

top
HttpProxyPort
int CkFtp2_getHttpProxyPort(HCkFtp2 cHandle);
void CkFtp2_putHttpProxyPort(HCkFtp2 cHandle, int newVal);

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

top
HttpProxyUsername
void CkFtp2_getHttpProxyUsername(HCkFtp2 cHandle, HCkString retval);
void CkFtp2_putHttpProxyUsername(HCkFtp2 cHandle, const char *newVal);
const char *CkFtp2_httpProxyUsername(HCkFtp2 cHandle);

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

More Information and Examples
top
IdleTimeoutMs
int CkFtp2_getIdleTimeoutMs(HCkFtp2 cHandle);
void CkFtp2_putIdleTimeoutMs(HCkFtp2 cHandle, int newVal);

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

top
IsConnected
BOOL CkFtp2_getIsConnected(HCkFtp2 cHandle);

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

Returns TRUE if currently connected and logged into an FTP server, otherwise returns FALSE.

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

top
KeepSessionLog
BOOL CkFtp2_getKeepSessionLog(HCkFtp2 cHandle);
void CkFtp2_putKeepSessionLog(HCkFtp2 cHandle, BOOL newVal);

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

top
LargeFileMeasures
BOOL CkFtp2_getLargeFileMeasures(HCkFtp2 cHandle);
void CkFtp2_putLargeFileMeasures(HCkFtp2 cHandle, BOOL newVal);
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 TRUE will keep the control connection very slightly used to prevent this from happening.

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

top
LastErrorHtml
void CkFtp2_getLastErrorHtml(HCkFtp2 cHandle, HCkString retval);
const char *CkFtp2_lastErrorHtml(HCkFtp2 cHandle);

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.

top
LastErrorText
void CkFtp2_getLastErrorText(HCkFtp2 cHandle, HCkString retval);
const char *CkFtp2_lastErrorText(HCkFtp2 cHandle);

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.

top
LastErrorXml
void CkFtp2_getLastErrorXml(HCkFtp2 cHandle, HCkString retval);
const char *CkFtp2_lastErrorXml(HCkFtp2 cHandle);

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.

top
LastMethodSuccess
BOOL CkFtp2_getLastMethodSuccess(HCkFtp2 cHandle);
void CkFtp2_putLastMethodSuccess(HCkFtp2 cHandle, BOOL newVal);
Introduced in version 9.5.0.52

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

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

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

top
LastReply
void CkFtp2_getLastReply(HCkFtp2 cHandle, HCkString retval);
const char *CkFtp2_lastReply(HCkFtp2 cHandle);

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.

top
ListPattern
void CkFtp2_getListPattern(HCkFtp2 cHandle, HCkString retval);
void CkFtp2_putListPattern(HCkFtp2 cHandle, const char *newVal);
const char *CkFtp2_listPattern(HCkFtp2 cHandle);

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

top
LoginVerified
BOOL CkFtp2_getLoginVerified(HCkFtp2 cHandle);

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

top
PartialTransfer
BOOL CkFtp2_getPartialTransfer(HCkFtp2 cHandle);

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

top
Passive
BOOL CkFtp2_getPassive(HCkFtp2 cHandle);
void CkFtp2_putPassive(HCkFtp2 cHandle, BOOL newVal);

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

top
PassiveUseHostAddr
BOOL CkFtp2_getPassiveUseHostAddr(HCkFtp2 cHandle);
void CkFtp2_putPassiveUseHostAddr(HCkFtp2 cHandle, BOOL newVal);

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 TRUE, 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 FALSE.

top
Password
void CkFtp2_getPassword(HCkFtp2 cHandle, HCkString retval);
void CkFtp2_putPassword(HCkFtp2 cHandle, const char *newVal);
const char *CkFtp2_password(HCkFtp2 cHandle);

Password for logging into the FTP server.

top
PercentDoneScale
int CkFtp2_getPercentDoneScale(HCkFtp2 cHandle);
void CkFtp2_putPercentDoneScale(HCkFtp2 cHandle, int newVal);
Introduced in version 9.5.0.49

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

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

top
Port
int CkFtp2_getPort(HCkFtp2 cHandle);
void CkFtp2_putPort(HCkFtp2 cHandle, int newVal);

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

top
PreferIpv6
BOOL CkFtp2_getPreferIpv6(HCkFtp2 cHandle);
void CkFtp2_putPreferIpv6(HCkFtp2 cHandle, BOOL newVal);

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

top
PreferNlst
BOOL CkFtp2_getPreferNlst(HCkFtp2 cHandle);
void CkFtp2_putPreferNlst(HCkFtp2 cHandle, BOOL newVal);

If TRUE, 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 FALSE.

top
ProgressMonSize
int CkFtp2_getProgressMonSize(HCkFtp2 cHandle);
void CkFtp2_putProgressMonSize(HCkFtp2 cHandle, int newVal);

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.

More Information and Examples
top
ProgressMonSize64
__int64 CkFtp2_getProgressMonSize64(HCkFtp2 cHandle);
void CkFtp2_putProgressMonSize64(HCkFtp2 cHandle, __int64 newVal);

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

top
ProxyHostname
void CkFtp2_getProxyHostname(HCkFtp2 cHandle, HCkString retval);
void CkFtp2_putProxyHostname(HCkFtp2 cHandle, const char *newVal);
const char *CkFtp2_proxyHostname(HCkFtp2 cHandle);

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

top
ProxyMethod
int CkFtp2_getProxyMethod(HCkFtp2 cHandle);
void CkFtp2_putProxyMethod(HCkFtp2 cHandle, int newVal);

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

top
ProxyPassword
void CkFtp2_getProxyPassword(HCkFtp2 cHandle, HCkString retval);
void CkFtp2_putProxyPassword(HCkFtp2 cHandle, const char *newVal);
const char *CkFtp2_proxyPassword(HCkFtp2 cHandle);

The password for authenticating with the FTP proxy server.

top
ProxyPort
int CkFtp2_getProxyPort(HCkFtp2 cHandle);
void CkFtp2_putProxyPort(HCkFtp2 cHandle, int newVal);

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

top
ProxyUsername
void CkFtp2_getProxyUsername(HCkFtp2 cHandle, HCkString retval);
void CkFtp2_putProxyUsername(HCkFtp2 cHandle, const char *newVal);
const char *CkFtp2_proxyUsername(HCkFtp2 cHandle);

The username for authenticating with the FTP proxy server.

top
ReadTimeout
int CkFtp2_getReadTimeout(HCkFtp2 cHandle);
void CkFtp2_putReadTimeout(HCkFtp2 cHandle, int newVal);

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.

top
RequireSslCertVerify
BOOL CkFtp2_getRequireSslCertVerify(HCkFtp2 cHandle);
void CkFtp2_putRequireSslCertVerify(HCkFtp2 cHandle, BOOL newVal);

If TRUE, 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 FALSE.

top
RestartNext
BOOL CkFtp2_getRestartNext(HCkFtp2 cHandle);
void CkFtp2_putRestartNext(HCkFtp2 cHandle, BOOL newVal);

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

top
SessionLog
void CkFtp2_getSessionLog(HCkFtp2 cHandle, HCkString retval);
const char *CkFtp2_sessionLog(HCkFtp2 cHandle);

Contains the session log if KeepSessionLog is turned on.

top
SocksHostname
void CkFtp2_getSocksHostname(HCkFtp2 cHandle, HCkString retval);
void CkFtp2_putSocksHostname(HCkFtp2 cHandle, const char *newVal);
const char *CkFtp2_socksHostname(HCkFtp2 cHandle);

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

More Information and Examples
top
SocksPassword
void CkFtp2_getSocksPassword(HCkFtp2 cHandle, HCkString retval);
void CkFtp2_putSocksPassword(HCkFtp2 cHandle, const char *newVal);
const char *CkFtp2_socksPassword(HCkFtp2 cHandle);

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

top
SocksPort
int CkFtp2_getSocksPort(HCkFtp2 cHandle);
void CkFtp2_putSocksPort(HCkFtp2 cHandle, int newVal);

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

top
SocksUsername
void CkFtp2_getSocksUsername(HCkFtp2 cHandle, HCkString retval);
void CkFtp2_putSocksUsername(HCkFtp2 cHandle, const char *newVal);
const char *CkFtp2_socksUsername(HCkFtp2 cHandle);

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

top
SocksVersion
int CkFtp2_getSocksVersion(HCkFtp2 cHandle);
void CkFtp2_putSocksVersion(HCkFtp2 cHandle, int newVal);

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.

top
SoRcvBuf
int CkFtp2_getSoRcvBuf(HCkFtp2 cHandle);
void CkFtp2_putSoRcvBuf(HCkFtp2 cHandle, int newVal);

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.

top
SoSndBuf
int CkFtp2_getSoSndBuf(HCkFtp2 cHandle);
void CkFtp2_putSoSndBuf(HCkFtp2 cHandle, int newVal);

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.

top
Ssl
BOOL CkFtp2_getSsl(HCkFtp2 cHandle);
void CkFtp2_putSsl(HCkFtp2 cHandle, BOOL newVal);

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

top
SslAllowedCiphers
void CkFtp2_getSslAllowedCiphers(HCkFtp2 cHandle, HCkString retval);
void CkFtp2_putSslAllowedCiphers(HCkFtp2 cHandle, const char *newVal);
const char *CkFtp2_sslAllowedCiphers(HCkFtp2 cHandle);
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"

top
SslProtocol
void CkFtp2_getSslProtocol(HCkFtp2 cHandle, HCkString retval);
void CkFtp2_putSslProtocol(HCkFtp2 cHandle, const char *newVal);
const char *CkFtp2_sslProtocol(HCkFtp2 cHandle);

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

top
SslServerCertVerified
BOOL CkFtp2_getSslServerCertVerified(HCkFtp2 cHandle);

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

top
SyncCreateAllLocalDirs
BOOL CkFtp2_getSyncCreateAllLocalDirs(HCkFtp2 cHandle);
void CkFtp2_putSyncCreateAllLocalDirs(HCkFtp2 cHandle, BOOL newVal);
Introduced in version 9.5.0.76

If TRUE, then empty directories on the server are created locally when doing a download synchronization. If FALSE, then only directories containing files that are downloaded are auto-created.

The default value of this property is TRUE.

top
SyncedFiles
void CkFtp2_getSyncedFiles(HCkFtp2 cHandle, HCkString retval);
void CkFtp2_putSyncedFiles(HCkFtp2 cHandle, const char *newVal);
const char *CkFtp2_syncedFiles(HCkFtp2 cHandle);
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.

top
SyncMustMatch
void CkFtp2_getSyncMustMatch(HCkFtp2 cHandle, HCkString retval);
void CkFtp2_putSyncMustMatch(HCkFtp2 cHandle, const char *newVal);
const char *CkFtp2_syncMustMatch(HCkFtp2 cHandle);

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.

top
SyncMustMatchDir
void CkFtp2_getSyncMustMatchDir(HCkFtp2 cHandle, HCkString retval);
void CkFtp2_putSyncMustMatchDir(HCkFtp2 cHandle, const char *newVal);
const char *CkFtp2_syncMustMatchDir(HCkFtp2 cHandle);
Introduced in version 9.5.0.76

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

top
SyncMustNotMatch
void CkFtp2_getSyncMustNotMatch(HCkFtp2 cHandle, HCkString retval);
void CkFtp2_putSyncMustNotMatch(HCkFtp2 cHandle, const char *newVal);
const char *CkFtp2_syncMustNotMatch(HCkFtp2 cHandle);

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.

top
SyncMustNotMatchDir
void CkFtp2_getSyncMustNotMatchDir(HCkFtp2 cHandle, HCkString retval);
void CkFtp2_putSyncMustNotMatchDir(HCkFtp2 cHandle, const char *newVal);
const char *CkFtp2_syncMustNotMatchDir(HCkFtp2 cHandle);
Introduced in version 9.5.0.76

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

top
SyncPreview
void CkFtp2_getSyncPreview(HCkFtp2 cHandle, HCkString retval);
const char *CkFtp2_syncPreview(HCkFtp2 cHandle);

Contains the list of files that would be transferred in a call to SyncRemoteTree2 when the previewOnly argument is set to TRUE. 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.

top
TlsCipherSuite
void CkFtp2_getTlsCipherSuite(HCkFtp2 cHandle, HCkString retval);
const char *CkFtp2_tlsCipherSuite(HCkFtp2 cHandle);
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.

top
TlsPinSet
void CkFtp2_getTlsPinSet(HCkFtp2 cHandle, HCkString retval);
void CkFtp2_putTlsPinSet(HCkFtp2 cHandle, const char *newVal);
const char *CkFtp2_tlsPinSet(HCkFtp2 cHandle);
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.

More Information and Examples
top
TlsVersion
void CkFtp2_getTlsVersion(HCkFtp2 cHandle, HCkString retval);
const char *CkFtp2_tlsVersion(HCkFtp2 cHandle);
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".

top
UploadTransferRate
int CkFtp2_getUploadTransferRate(HCkFtp2 cHandle);

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

top
UseEpsv
BOOL CkFtp2_getUseEpsv(HCkFtp2 cHandle);
void CkFtp2_putUseEpsv(HCkFtp2 cHandle, BOOL newVal);

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

Note: If the AutoFeat property is TRUE, then the FTP server's features are automatically queried after connecting. In this case, if the AutoSetUseEpsv property is also set to TRUE, the UseEpsv property is automatically set to TRUE 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 FALSE.

More Information and Examples
top
Username
void CkFtp2_getUsername(HCkFtp2 cHandle, HCkString retval);
void CkFtp2_putUsername(HCkFtp2 cHandle, const char *newVal);
const char *CkFtp2_username(HCkFtp2 cHandle);

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

top
Utf8
BOOL CkFtp2_getUtf8(HCkFtp2 cHandle);
void CkFtp2_putUtf8(HCkFtp2 cHandle, BOOL newVal);

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

top
VerboseLogging
BOOL CkFtp2_getVerboseLogging(HCkFtp2 cHandle);
void CkFtp2_putVerboseLogging(HCkFtp2 cHandle, BOOL newVal);

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.

top
Version
void CkFtp2_getVersion(HCkFtp2 cHandle, HCkString retval);
const char *CkFtp2_version(HCkFtp2 cHandle);

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

top

Methods

AppendFile
BOOL CkFtp2_AppendFile(HCkFtp2 cHandle, const char *localFilePath, const char *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 TRUE for success, FALSE for failure.

top
AppendFileAsync (1)
HCkTask CkFtp2_AppendFileAsync(HCkFtp2 cHandle, const char *localFilePath, const char *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

top
AppendFileFromBinaryData
BOOL CkFtp2_AppendFileFromBinaryData(HCkFtp2 cHandle, const char *remoteFilename, HCkByteData content);

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

Returns TRUE for success, FALSE for failure.

top
AppendFileFromBinaryDataAsync (1)
HCkTask CkFtp2_AppendFileFromBinaryDataAsync(HCkFtp2 cHandle, const char *remoteFilename, HCkByteData 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

top
AppendFileFromTextData
BOOL CkFtp2_AppendFileFromTextData(HCkFtp2 cHandle, const char *remoteFilename, const char *textData, const char *charset);

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

Returns TRUE for success, FALSE for failure.

top
AppendFileFromTextDataAsync (1)
HCkTask CkFtp2_AppendFileFromTextDataAsync(HCkFtp2 cHandle, const char *remoteFilename, const char *textData, const char *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

top
ChangeRemoteDir
BOOL CkFtp2_ChangeRemoteDir(HCkFtp2 cHandle, const char *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 TRUE for success, FALSE for failure.

top
ChangeRemoteDirAsync (1)
HCkTask CkFtp2_ChangeRemoteDirAsync(HCkFtp2 cHandle, const char *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

top
CheckConnection
BOOL CkFtp2_CheckConnection(HCkFtp2 cHandle);
Introduced in version 9.5.0.44

Returns TRUE if currently connected and logged into an FTP server, otherwise returns FALSE.

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

Returns TRUE for success, FALSE for failure.

top
CheckConnectionAsync (1)
HCkTask CkFtp2_CheckConnectionAsync(HCkFtp2 cHandle);
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

top
ClearControlChannel
BOOL CkFtp2_ClearControlChannel(HCkFtp2 cHandle);

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 TRUE for success, FALSE for failure.

top
ClearControlChannelAsync (1)
HCkTask CkFtp2_ClearControlChannelAsync(HCkFtp2 cHandle);

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

top
ClearDirCache
void CkFtp2_ClearDirCache(HCkFtp2 cHandle);

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.

top
ClearSessionLog
void CkFtp2_ClearSessionLog(HCkFtp2 cHandle);

Clears the in-memory session log.

top
Connect
BOOL CkFtp2_Connect(HCkFtp2 cHandle);

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 FALSE (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 TRUE for success, FALSE for failure.

top
ConnectAsync (1)
HCkTask CkFtp2_ConnectAsync(HCkFtp2 cHandle);

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

top
ConnectOnly
BOOL CkFtp2_ConnectOnly(HCkFtp2 cHandle);

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 TRUE for success, FALSE for failure.

top
ConnectOnlyAsync (1)
HCkTask CkFtp2_ConnectOnlyAsync(HCkFtp2 cHandle);

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

top
ConvertToTls
BOOL CkFtp2_ConvertToTls(HCkFtp2 cHandle);

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 TRUE, 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 TRUE for success, FALSE for failure.

top
ConvertToTlsAsync (1)
HCkTask CkFtp2_ConvertToTlsAsync(HCkFtp2 cHandle);

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

top
CreatePlan
BOOL CkFtp2_CreatePlan(HCkFtp2 cHandle, const char *localDir, HCkString outStr);
const char *CkFtp2_createPlan(HCkFtp2 cHandle, const char *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 TRUE for success, FALSE for failure.

More Information and Examples
top
CreatePlanAsync (1)
HCkTask CkFtp2_CreatePlanAsync(HCkFtp2 cHandle, const char *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

top
CreateRemoteDir
BOOL CkFtp2_CreateRemoteDir(HCkFtp2 cHandle, const char *remoteDirPath);

Creates a directory on the FTP server. If the directory already exists, a new one is not created and FALSE 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 TRUE for success, FALSE for failure.

top
CreateRemoteDirAsync (1)
HCkTask CkFtp2_CreateRemoteDirAsync(HCkFtp2 cHandle, const char *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

top
DeleteMatching
int CkFtp2_DeleteMatching(HCkFtp2 cHandle, const char *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.

top
DeleteMatchingAsync (1)
HCkTask CkFtp2_DeleteMatchingAsync(HCkFtp2 cHandle, const char *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

top
DeleteRemoteFile
BOOL CkFtp2_DeleteRemoteFile(HCkFtp2 cHandle, const char *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 TRUE for success, FALSE for failure.

top
DeleteRemoteFileAsync (1)
HCkTask CkFtp2_DeleteRemoteFileAsync(HCkFtp2 cHandle, const char *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

top
DeleteTree
BOOL CkFtp2_DeleteTree(HCkFtp2 cHandle);

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 TRUE for success, FALSE for failure.

More Information and Examples
top
DeleteTreeAsync (1)
HCkTask CkFtp2_DeleteTreeAsync(HCkFtp2 cHandle);

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

top
DetermineProxyMethod
int CkFtp2_DetermineProxyMethod(HCkFtp2 cHandle);

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

More Information and Examples
top
DetermineProxyMethodAsync (1)
HCkTask CkFtp2_DetermineProxyMethodAsync(HCkFtp2 cHandle);

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

top
DetermineSettings
BOOL CkFtp2_DetermineSettings(HCkFtp2 cHandle, HCkString outXmlReport);
const char *CkFtp2_determineSettings(HCkFtp2 cHandle);

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 TRUE for success, FALSE for failure.

More Information and Examples
top
DetermineSettingsAsync (1)
HCkTask CkFtp2_DetermineSettingsAsync(HCkFtp2 cHandle);

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

top
DirTreeXml
BOOL CkFtp2_DirTreeXml(HCkFtp2 cHandle, HCkString outStrXml);
const char *CkFtp2_dirTreeXml(HCkFtp2 cHandle);

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 TRUE for success, FALSE for failure.

More Information and Examples
top
DirTreeXmlAsync (1)
HCkTask CkFtp2_DirTreeXmlAsync(HCkFtp2 cHandle);

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

top
Disconnect
BOOL CkFtp2_Disconnect(HCkFtp2 cHandle);

Disconnects from the FTP server, ending the current session.

Returns TRUE for success, FALSE for failure.

top
DisconnectAsync (1)
HCkTask CkFtp2_DisconnectAsync(HCkFtp2 cHandle);

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

top
DownloadTree
BOOL CkFtp2_DownloadTree(HCkFtp2 cHandle, const char *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 TRUE for success, FALSE for failure.

top
DownloadTreeAsync (1)
HCkTask CkFtp2_DownloadTreeAsync(HCkFtp2 cHandle, const char *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

top
Feat
BOOL CkFtp2_Feat(HCkFtp2 cHandle, HCkString outStr);
const char *CkFtp2_feat(HCkFtp2 cHandle);

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 TRUE for success, FALSE for failure.

More Information and Examples
top
FeatAsync (1)
HCkTask CkFtp2_FeatAsync(HCkFtp2 cHandle);

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

top
GetCreateDt
HCkDateTime CkFtp2_GetCreateDt(HCkFtp2 cHandle, int 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

top
GetCreateDtAsync (1) (2)
HCkTask CkFtp2_GetCreateDtAsync(HCkFtp2 cHandle, int 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

top
GetCreateDtByName
HCkDateTime CkFtp2_GetCreateDtByName(HCkFtp2 cHandle, const char *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

top
GetCreateDtByNameAsync (1) (2)
HCkTask CkFtp2_GetCreateDtByNameAsync(HCkFtp2 cHandle, const char *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

top
GetCreateTimeByNameStr
BOOL CkFtp2_GetCreateTimeByNameStr(HCkFtp2 cHandle, const char *filename, HCkString outStr);
const char *CkFtp2_getCreateTimeByNameStr(HCkFtp2 cHandle, const char *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 TRUE for success, FALSE for failure.

top
GetCreateTimeByNameStrAsync (1)
HCkTask CkFtp2_GetCreateTimeByNameStrAsync(HCkFtp2 cHandle, const char *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

top
GetCreateTimeStr
BOOL CkFtp2_GetCreateTimeStr(HCkFtp2 cHandle, int index, HCkString outStr);
const char *CkFtp2_getCreateTimeStr(HCkFtp2 cHandle, int 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 TRUE for success, FALSE for failure.

top
GetCreateTimeStrAsync (1)
HCkTask CkFtp2_GetCreateTimeStrAsync(HCkFtp2 cHandle, int 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

top
GetCurrentRemoteDir
BOOL CkFtp2_GetCurrentRemoteDir(HCkFtp2 cHandle, HCkString outStr);
const char *CkFtp2_getCurrentRemoteDir(HCkFtp2 cHandle);

Returns the current remote directory.

Returns TRUE for success, FALSE for failure.

top
GetCurrentRemoteDirAsync (1)
HCkTask CkFtp2_GetCurrentRemoteDirAsync(HCkFtp2 cHandle);

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

top
GetDirCount
int CkFtp2_GetDirCount(HCkFtp2 cHandle);
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 = TRUE, with the PassiveUseHostAddr property also set equal to TRUE. 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 TRUE for success, FALSE for failure.

top
GetDirCountAsync (1)
HCkTask CkFtp2_GetDirCountAsync(HCkFtp2 cHandle);
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

top
GetFile
BOOL CkFtp2_GetFile(HCkFtp2 cHandle, const char *remoteFilePath, const char *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 TRUE for success, FALSE for failure.

top
GetFileAsync (1)
HCkTask CkFtp2_GetFileAsync(HCkFtp2 cHandle, const char *remoteFilePath, const char *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

More Information and Examples
top
GetFileBd
BOOL CkFtp2_GetFileBd(HCkFtp2 cHandle, const char *remoteFilePath, HCkBinData 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 TRUE for success, FALSE for failure.

More Information and Examples
top
GetFileBdAsync (1)
HCkTask CkFtp2_GetFileBdAsync(HCkFtp2 cHandle, const char *remoteFilePath, HCkBinData 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

top
GetFilename
BOOL CkFtp2_GetFilename(HCkFtp2 cHandle, int index, HCkString outStr);
const char *CkFtp2_getFilename(HCkFtp2 cHandle, int 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 TRUE for success, FALSE for failure.

top
GetFilenameAsync (1)
HCkTask CkFtp2_GetFilenameAsync(HCkFtp2 cHandle, int 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

top
GetFileSb
BOOL CkFtp2_GetFileSb(HCkFtp2 cHandle, const char *remoteFilePath, const char *charset, HCkStringBuilder 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 TRUE for success, FALSE for failure.

More Information and Examples
top
GetFileSbAsync (1)
HCkTask CkFtp2_GetFileSbAsync(HCkFtp2 cHandle, const char *remoteFilePath, const char *charset, HCkStringBuilder 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

top
GetFileToStream
BOOL CkFtp2_GetFileToStream(HCkFtp2 cHandle, const char *remoteFilePath, HCkStream 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 TRUE for success, FALSE for failure.

top
GetFileToStreamAsync (1)
HCkTask CkFtp2_GetFileToStreamAsync(HCkFtp2 cHandle, const char *remoteFilePath, HCkStream 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

top
GetGroup
BOOL CkFtp2_GetGroup(HCkFtp2 cHandle, int index, HCkString outStr);
const char *CkFtp2_getGroup(HCkFtp2 cHandle, int 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 FALSE 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 TRUE for success, FALSE for failure.

top
GetGroupAsync (1)
HCkTask CkFtp2_GetGroupAsync(HCkFtp2 cHandle, int 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

top
GetIsDirectory
BOOL CkFtp2_GetIsDirectory(HCkFtp2 cHandle, int index);

Returns TRUE for a sub-directory and FALSE 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)

top
GetIsDirectoryAsync (1)
HCkTask CkFtp2_GetIsDirectoryAsync(HCkFtp2 cHandle, int 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

top
GetIsSymbolicLink
BOOL CkFtp2_GetIsSymbolicLink(HCkFtp2 cHandle, int index);

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

top
GetIsSymbolicLinkAsync (1)
HCkTask CkFtp2_GetIsSymbolicLinkAsync(HCkFtp2 cHandle, int 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

top
GetLastAccessDt
HCkDateTime CkFtp2_GetLastAccessDt(HCkFtp2 cHandle, int 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

top
GetLastAccessDtAsync (1) (2)
HCkTask CkFtp2_GetLastAccessDtAsync(HCkFtp2 cHandle, int 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

top
GetLastAccessDtByName
HCkDateTime CkFtp2_GetLastAccessDtByName(HCkFtp2 cHandle, const char *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

top
GetLastAccessDtByNameAsync (1) (2)
HCkTask CkFtp2_GetLastAccessDtByNameAsync(HCkFtp2 cHandle, const char *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

top
GetLastAccessTimeByNameStr
BOOL CkFtp2_GetLastAccessTimeByNameStr(HCkFtp2 cHandle, const char *filename, HCkString outStr);
const char *CkFtp2_getLastAccessTimeByNameStr(HCkFtp2 cHandle, const char *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 TRUE for success, FALSE for failure.

top
GetLastAccessTimeByNameStrAsync (1)
HCkTask CkFtp2_GetLastAccessTimeByNameStrAsync(HCkFtp2 cHandle, const char *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

top
GetLastAccessTimeStr
BOOL CkFtp2_GetLastAccessTimeStr(HCkFtp2 cHandle, int index, HCkString outStr);
const char *CkFtp2_getLastAccessTimeStr(HCkFtp2 cHandle, int 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 TRUE for success, FALSE for failure.

top
GetLastAccessTimeStrAsync (1)
HCkTask CkFtp2_GetLastAccessTimeStrAsync(HCkFtp2 cHandle, int 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

top
GetLastModDt
HCkDateTime CkFtp2_GetLastModDt(HCkFtp2 cHandle, int 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

top
GetLastModDtAsync (1) (2)
HCkTask CkFtp2_GetLastModDtAsync(HCkFtp2 cHandle, int 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

top
GetLastModDtByName
HCkDateTime CkFtp2_GetLastModDtByName(HCkFtp2 cHandle, const char *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

top
GetLastModDtByNameAsync (1) (2)
HCkTask CkFtp2_GetLastModDtByNameAsync(HCkFtp2 cHandle, const char *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

top
GetLastModifiedTimeByNameStr
BOOL CkFtp2_GetLastModifiedTimeByNameStr(HCkFtp2 cHandle, const char *filename, HCkString outStr);
const char *CkFtp2_getLastModifiedTimeByNameStr(HCkFtp2 cHandle, const char *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 TRUE for success, FALSE for failure.

top
GetLastModifiedTimeByNameStrAsync (1)
HCkTask CkFtp2_GetLastModifiedTimeByNameStrAsync(HCkFtp2 cHandle, const char *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

top
GetLastModifiedTimeStr
BOOL CkFtp2_GetLastModifiedTimeStr(HCkFtp2 cHandle, int index, HCkString outStr);
const char *CkFtp2_getLastModifiedTimeStr(HCkFtp2 cHandle, int 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 TRUE for success, FALSE for failure.

top
GetLastModifiedTimeStrAsync (1)
HCkTask CkFtp2_GetLastModifiedTimeStrAsync(HCkFtp2 cHandle, int 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

top
GetOwner
BOOL CkFtp2_GetOwner(HCkFtp2 cHandle, int index, HCkString outStr);
const char *CkFtp2_getOwner(HCkFtp2 cHandle, int 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 FALSE 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 TRUE for success, FALSE for failure.

top
GetOwnerAsync (1)
HCkTask CkFtp2_GetOwnerAsync(HCkFtp2 cHandle, int 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

top
GetPermissions
BOOL CkFtp2_GetPermissions(HCkFtp2 cHandle, int index, HCkString outStr);
const char *CkFtp2_getPermissions(HCkFtp2 cHandle, int 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 TRUE for success, FALSE for failure.

More Information and Examples
top
GetPermissionsAsync (1)
HCkTask CkFtp2_GetPermissionsAsync(HCkFtp2 cHandle, int 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

top
GetPermType
BOOL CkFtp2_GetPermType(HCkFtp2 cHandle, int index, HCkString outStr);
const char *CkFtp2_getPermType(HCkFtp2 cHandle, int 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 TRUE for success, FALSE for failure.

More Information and Examples
top
GetPermTypeAsync (1)
HCkTask CkFtp2_GetPermTypeAsync(HCkFtp2 cHandle, int 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

top
GetRemoteFileBinaryData
BOOL CkFtp2_GetRemoteFileBinaryData(HCkFtp2 cHandle, const char *remoteFilename, HCkByteData outData);

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

Returns TRUE for success, FALSE for failure.

More Information and Examples
top
GetRemoteFileBinaryDataAsync (1)
HCkTask CkFtp2_GetRemoteFileBinaryDataAsync(HCkFtp2 cHandle, const char *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

top
GetRemoteFileTextC
BOOL CkFtp2_GetRemoteFileTextC(HCkFtp2 cHandle, const char *remoteFilename, const char *charset, HCkString outStr);
const char *CkFtp2_getRemoteFileTextC(HCkFtp2 cHandle, const char *remoteFilename, const char *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 TRUE for success, FALSE for failure.

More Information and Examples
top
GetRemoteFileTextCAsync (1)
HCkTask CkFtp2_GetRemoteFileTextCAsync(HCkFtp2 cHandle, const char *remoteFilename, const char *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

top
GetRemoteFileTextData
BOOL CkFtp2_GetRemoteFileTextData(HCkFtp2 cHandle, const char *remoteFilename, HCkString outStr);
const char *CkFtp2_getRemoteFileTextData(HCkFtp2 cHandle, const char *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 TRUE for success, FALSE for failure.

top
GetRemoteFileTextDataAsync (1)
HCkTask CkFtp2_GetRemoteFileTextDataAsync(HCkFtp2 cHandle, const char *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

top
GetSize
int CkFtp2_GetSize(HCkFtp2 cHandle, int index);

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

top
GetSizeAsync (1)
HCkTask CkFtp2_GetSizeAsync(HCkFtp2 cHandle, int 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

top
GetSize64
__int64 CkFtp2_GetSize64(HCkFtp2 cHandle, int 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.

top
GetSizeByName
int CkFtp2_GetSizeByName(HCkFtp2 cHandle, const char *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.)

top
GetSizeByNameAsync (1)
HCkTask CkFtp2_GetSizeByNameAsync(HCkFtp2 cHandle, const char *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

top
GetSizeByName64
__int64 CkFtp2_GetSizeByName64(HCkFtp2 cHandle, const char *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.)

top
GetSizeStr
BOOL CkFtp2_GetSizeStr(HCkFtp2 cHandle, int index, HCkString outStr);
const char *CkFtp2_getSizeStr(HCkFtp2 cHandle, int 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 TRUE for success, FALSE for failure.

top
GetSizeStrAsync (1)
HCkTask CkFtp2_GetSizeStrAsync(HCkFtp2 cHandle, int 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

top
GetSizeStrByName
BOOL CkFtp2_GetSizeStrByName(HCkFtp2 cHandle, const char *filename, HCkString outStr);
const char *CkFtp2_getSizeStrByName(HCkFtp2 cHandle, const char *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 TRUE for success, FALSE for failure.

top
GetSizeStrByNameAsync (1)
HCkTask CkFtp2_GetSizeStrByNameAsync(HCkFtp2 cHandle, const char *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

top
GetSslServerCert
HCkCert CkFtp2_GetSslServerCert(HCkFtp2 cHandle);

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

Returns NULL on failure

top
GetTextDirListing
BOOL CkFtp2_GetTextDirListing(HCkFtp2 cHandle, const char *pattern, HCkString outStrRawListing);
const char *CkFtp2_getTextDirListing(HCkFtp2 cHandle, const char *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 TRUE for success, FALSE for failure.

More Information and Examples
top
GetTextDirListingAsync (1)
HCkTask CkFtp2_GetTextDirListingAsync(HCkFtp2 cHandle, const char *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

top
GetXmlDirListing
BOOL CkFtp2_GetXmlDirListing(HCkFtp2 cHandle, const char *pattern, HCkString outStrXmlListing);
const char *CkFtp2_getXmlDirListing(HCkFtp2 cHandle, const char *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 TRUE for success, FALSE for failure.

top
GetXmlDirListingAsync (1)
HCkTask CkFtp2_GetXmlDirListingAsync(HCkFtp2 cHandle, const char *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

top
IsUnlocked
BOOL CkFtp2_IsUnlocked(HCkFtp2 cHandle);

Return true if the component is already unlocked.

top
LargeFileUpload
BOOL CkFtp2_LargeFileUpload(HCkFtp2 cHandle, const char *localPath, const char *remotePath, int 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 TRUE for success, FALSE for failure.

More Information and Examples
top
LargeFileUploadAsync (1)
HCkTask CkFtp2_LargeFileUploadAsync(HCkFtp2 cHandle, const char *localPath, const char *remotePath, int 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

top
LoginAfterConnectOnly
BOOL CkFtp2_LoginAfterConnectOnly(HCkFtp2 cHandle);

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

Returns TRUE for success, FALSE for failure.

top
LoginAfterConnectOnlyAsync (1)
HCkTask CkFtp2_LoginAfterConnectOnlyAsync(HCkFtp2 cHandle);

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

top
MGetFiles
int CkFtp2_MGetFiles(HCkFtp2 cHandle, const char *remotePattern, const char *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.

top
MGetFilesAsync (1)
HCkTask CkFtp2_MGetFilesAsync(HCkFtp2 cHandle, const char *remotePattern, const char *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

top
MPutFiles
int CkFtp2_MPutFiles(HCkFtp2 cHandle, const char *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.[

top
MPutFilesAsync (1)
HCkTask CkFtp2_MPutFilesAsync(HCkFtp2 cHandle, const char *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

top
NlstXml
BOOL CkFtp2_NlstXml(HCkFtp2 cHandle, const char *remoteDirPattern, HCkString outStr);
const char *CkFtp2_nlstXml(HCkFtp2 cHandle, const char *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 TRUE for success, FALSE for failure.

top
NlstXmlAsync (1)
HCkTask CkFtp2_NlstXmlAsync(HCkFtp2 cHandle, const char *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

top
Noop
BOOL CkFtp2_Noop(HCkFtp2 cHandle);

Issues a no-op command to the FTP server.

Returns TRUE for success, FALSE for failure.

top
NoopAsync (1)
HCkTask CkFtp2_NoopAsync(HCkFtp2 cHandle);

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

top
PutFile
BOOL CkFtp2_PutFile(HCkFtp2 cHandle, const char *localFilePath, const char *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 TRUE for success, FALSE for failure.

top
PutFileAsync (1)
HCkTask CkFtp2_PutFileAsync(HCkFtp2 cHandle, const char *localFilePath, const char *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

top
PutFileBd
BOOL CkFtp2_PutFileBd(HCkFtp2 cHandle, HCkBinData binData, const char *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 TRUE for success, FALSE for failure.

More Information and Examples
top
PutFileBdAsync (1)
HCkTask CkFtp2_PutFileBdAsync(HCkFtp2 cHandle, HCkBinData binData, const char *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

top
PutFileFromBinaryData
BOOL CkFtp2_PutFileFromBinaryData(HCkFtp2 cHandle, const char *remoteFilename, HCkByteData content);

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

Returns TRUE for success, FALSE for failure.

More Information and Examples
top
PutFileFromBinaryDataAsync (1)
HCkTask CkFtp2_PutFileFromBinaryDataAsync(HCkFtp2 cHandle, const char *remoteFilename, HCkByteData 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

top
PutFileFromTextData
BOOL CkFtp2_PutFileFromTextData(HCkFtp2 cHandle, const char *remoteFilename, const char *textData, const char *charset);

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

Returns TRUE for success, FALSE for failure.

More Information and Examples
top
PutFileFromTextDataAsync (1)
HCkTask CkFtp2_PutFileFromTextDataAsync(HCkFtp2 cHandle, const char *remoteFilename, const char *textData, const char *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

top
PutFileSb
BOOL CkFtp2_PutFileSb(HCkFtp2 cHandle, HCkStringBuilder sb, const char *charset, BOOL includeBom, const char *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 TRUE for success, FALSE for failure.

More Information and Examples
top
PutFileSbAsync (1)
HCkTask CkFtp2_PutFileSbAsync(HCkFtp2 cHandle, HCkStringBuilder sb, const char *charset, BOOL includeBom, const char *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

top
PutPlan
BOOL CkFtp2_PutPlan(HCkFtp2 cHandle, const char *plan, const char *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 TRUE for success, FALSE for failure.

More Information and Examples
top
PutPlanAsync (1)
HCkTask CkFtp2_PutPlanAsync(HCkFtp2 cHandle, const char *plan, const char *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

top
PutTree
BOOL CkFtp2_PutTree(HCkFtp2 cHandle, const char *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 TRUE for success, FALSE for failure.

top
PutTreeAsync (1)
HCkTask CkFtp2_PutTreeAsync(HCkFtp2 cHandle, const char *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

top
Quote
BOOL CkFtp2_Quote(HCkFtp2 cHandle, const char *cmd);

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

Returns TRUE for success, FALSE for failure.

More Information and Examples
top
QuoteAsync (1)
HCkTask CkFtp2_QuoteAsync(HCkFtp2 cHandle, const char *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

top
RemoveRemoteDir
BOOL CkFtp2_RemoveRemoteDir(HCkFtp2 cHandle, const char *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 TRUE for success, FALSE for failure.

top
RemoveRemoteDirAsync (1)
HCkTask CkFtp2_RemoveRemoteDirAsync(HCkFtp2 cHandle, const char *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

top
RenameRemoteFile
BOOL CkFtp2_RenameRemoteFile(HCkFtp2 cHandle, const char *existingRemoteFilePath, const char *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 TRUE for success, FALSE for failure.

top
RenameRemoteFileAsync (1)
HCkTask CkFtp2_RenameRemoteFileAsync(HCkFtp2 cHandle, const char *existingRemoteFilePath, const char *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

top
SaveLastError
BOOL CkFtp2_SaveLastError(HCkFtp2 cHandle, const char *path);

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

Returns TRUE for success, FALSE for failure.

top
SendCommand
BOOL CkFtp2_SendCommand(HCkFtp2 cHandle, const char *cmd, HCkString outReply);
const char *CkFtp2_sendCommand(HCkFtp2 cHandle, const char *cmd);

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

Returns TRUE for success, FALSE for failure.

More Information and Examples
top
SendCommandAsync (1)
HCkTask CkFtp2_SendCommandAsync(HCkFtp2 cHandle, const char *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

top
SetModeZ
BOOL CkFtp2_SetModeZ(HCkFtp2 cHandle);

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 TRUE for success, FALSE for failure.

top
SetModeZAsync (1)
HCkTask CkFtp2_SetModeZAsync(HCkFtp2 cHandle);

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

top
SetOldestDateStr
void CkFtp2_SetOldestDateStr(HCkFtp2 cHandle, const char *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".

top
SetOption
BOOL CkFtp2_SetOption(HCkFtp2 cHandle, const char *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 TRUE for success, FALSE for failure.

top
SetRemoteFileDateTimeStr
BOOL CkFtp2_SetRemoteFileDateTimeStr(HCkFtp2 cHandle, const char *dateTimeStr, const char *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 TRUE for success, FALSE for failure.

top
SetRemoteFileDateTimeStrAsync (1)
HCkTask CkFtp2_SetRemoteFileDateTimeStrAsync(HCkFtp2 cHandle, const char *dateTimeStr, const char *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

top
SetRemoteFileDt
BOOL CkFtp2_SetRemoteFileDt(HCkFtp2 cHandle, HCkDateTime dt, const char *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 TRUE for success, FALSE for failure.

top
SetRemoteFileDtAsync (1)
HCkTask CkFtp2_SetRemoteFileDtAsync(HCkFtp2 cHandle, HCkDateTime dt, const char *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

top
SetSecurePassword
BOOL CkFtp2_SetSecurePassword(HCkFtp2 cHandle, HCkSecureString password);
Introduced in version 9.5.0.76

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 TRUE for success, FALSE for failure.

top
SetSslCertRequirement
void CkFtp2_SetSslCertRequirement(HCkFtp2 cHandle, const char *reqName, const char *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.

top
SetSslClientCert
BOOL CkFtp2_SetSslClientCert(HCkFtp2 cHandle, HCkCert cert);

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

Returns TRUE for success, FALSE for failure.

top
SetSslClientCertPem
BOOL CkFtp2_SetSslClientCertPem(HCkFtp2 cHandle, const char *pemDataOrFilename, const char *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 TRUE for success, FALSE for failure.

top
SetSslClientCertPfx
BOOL CkFtp2_SetSslClientCertPfx(HCkFtp2 cHandle, const char *pfxFilename, const char *pfxPassword);

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

Returns TRUE for success, FALSE for failure.

top
SetTypeAscii
BOOL CkFtp2_SetTypeAscii(HCkFtp2 cHandle);

Set the FTP transfer mode to us-ascii.

Returns TRUE for success, FALSE for failure.

top
SetTypeAsciiAsync (1)
HCkTask CkFtp2_SetTypeAsciiAsync(HCkFtp2 cHandle);

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

top
SetTypeBinary
BOOL CkFtp2_SetTypeBinary(HCkFtp2 cHandle);

Set the FTP transfer mode to binary.

Returns TRUE for success, FALSE for failure.

top
SetTypeBinaryAsync (1)
HCkTask CkFtp2_SetTypeBinaryAsync(HCkFtp2 cHandle);

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

top
Site
BOOL CkFtp2_Site(HCkFtp2 cHandle, const char *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 TRUE for success, FALSE for failure.

top
SiteAsync (1)
HCkTask CkFtp2_SiteAsync(HCkFtp2 cHandle, const char *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

top
SleepMs
void CkFtp2_SleepMs(HCkFtp2 cHandle, int millisec);

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

top
Stat
BOOL CkFtp2_Stat(HCkFtp2 cHandle, HCkString outStr);
const char *CkFtp2_stat(HCkFtp2 cHandle);

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

Returns TRUE for success, FALSE for failure.

top
StatAsync (1)
HCkTask CkFtp2_StatAsync(HCkFtp2 cHandle);

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

top
SyncDeleteRemote
BOOL CkFtp2_SyncDeleteRemote(HCkFtp2 cHandle, const char *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 TRUE for success, FALSE for failure.

top
SyncDeleteRemoteAsync (1)
HCkTask CkFtp2_SyncDeleteRemoteAsync(HCkFtp2 cHandle, const char *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

top
SyncLocalDir
BOOL CkFtp2_SyncLocalDir(HCkFtp2 cHandle, const char *localRoot, int 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 TRUE for success, FALSE for failure.

top
SyncLocalDirAsync (1)
HCkTask CkFtp2_SyncLocalDirAsync(HCkFtp2 cHandle, const char *localRoot, int 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

top
SyncLocalTree
BOOL CkFtp2_SyncLocalTree(HCkFtp2 cHandle, const char *localRoot, int 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 TRUE for success, FALSE for failure.

More Information and Examples
top
SyncLocalTreeAsync (1)
HCkTask CkFtp2_SyncLocalTreeAsync(HCkFtp2 cHandle, const char *localRoot, int 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

top
SyncRemoteTree
BOOL CkFtp2_SyncRemoteTree(HCkFtp2 cHandle, const char *localRoot, int 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 TRUE for success, FALSE for failure.

More Information and Examples
top
SyncRemoteTreeAsync (1)
HCkTask CkFtp2_SyncRemoteTreeAsync(HCkFtp2 cHandle, const char *localRoot, int 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

top
SyncRemoteTree2
BOOL CkFtp2_SyncRemoteTree2(HCkFtp2 cHandle, const char *localDirPath, int mode, BOOL bDescend, BOOL bPreviewOnly);

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

Note: If bPreviewOnly is set to TRUE, 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 TRUE for success, FALSE for failure.

top
SyncRemoteTree2Async (1)
HCkTask CkFtp2_SyncRemoteTree2Async(HCkFtp2 cHandle, const char *localDirPath, int mode, BOOL bDescend, BOOL 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

top
Syst
BOOL CkFtp2_Syst(HCkFtp2 cHandle, HCkString outStr);
const char *CkFtp2_syst(HCkFtp2 cHandle);

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 TRUE for success, FALSE for failure.

top
SystAsync (1)
HCkTask CkFtp2_SystAsync(HCkFtp2 cHandle);

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

top
UnlockComponent
BOOL CkFtp2_UnlockComponent(HCkFtp2 cHandle, const char *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 TRUE for success, FALSE for failure.

top