CkScp

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

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.

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.

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.

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.

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.

A JSON string specifying environment variables that are to be set for each SCP upload or download. For example:

{
    "LCS_PASSWORD": "myPassword",
    "SOME_ENV_VAR": "some_value",
...
}

The paths of the files uploaded or downloaded in the last call to SyncUploadTree or SyncDownloadTree. The paths are listed one per line. In both cases (for upload and download) each line contains the full local file path (not the remote path).

Can contain a wildcarded list of filename patterns separated by semicolons. For example, "*.xml; *.txt; *.csv". If set, the SyncTreeUpload and SyncTreeDownload methods will only transfer files having a filename that matches any one of these patterns.

Can contain a wildcarded list of directory name patterns separated by semicolons. For example, "a*; b*; c*". If set, the SyncTreeUpload and SyncTreeDownload methods will only traverse into a directory that matches any one of these patterns.

Can contain a wildcarded list of filename patterns separated by semicolons. For example, "*.xml; *.txt; *.csv". If set, the SyncTreeUpload and SyncTreeDownload methods will not transfer files having a filename that matches any one of these patterns.

Can contain a wildcarded list of directory name patterns separated by semicolons. For example, "a*; b*; c*". If set, the SyncTreeUpload and SyncTreeDownload methods will not traverse into a directory that matches any one of these patterns.

This is a catch-all property to be used for uncommon needs. The default value is the empty string.

Can be set to a list of the following comma separated keywords:

• FilenameOnly - Introduced in v9.5.0.77. Set this property to the keyword "FilenameOnly" if only the filename should be used in the "scp -t" command. (LANCOM routers using SCP seem to need it.)
• ProtectFromVpn - Introduced in v9.5.0.80. On Android systems, will bypass any VPN that may be installed or active.

When Chilkat uploads a file by SCP, the UNIX permissions of the remote file are set based on the permissions of the local file being uploaded. Usually this is OK, but in some cases the access permissions of the local file are not what is wanted for the remote file. This property can be set to an octal permissions string, such as "0644", to force the remote file permissions to this value.

The default value of this property is the empty string (remote files permissions mirror the permissions of the local file being uploaded).

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.

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

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

Downloads a binary file from the SSH server and appends to the contents of bd.

Returns True for success, False for failure.

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

Returns None on failure

Downloads a binary file from the SSH server and returns the contents.

Returns True for success, False for failure.

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

Returns None on failure

Downloads a file from the SSH server returns the contents in an encoded string (using an encoding such as base64).

Returns True for success, False for failure.

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

Returns None on failure

Downloads a file from the remote SSH server to the local filesystem.

Returns True for success, False for failure.

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

Returns None on failure

Downloads a text file from the SSH server and returns the contents as a string.

Returns True for success, False for failure.

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

Returns None on failure

Loads the caller of the task's async method.

Returns True for success, False for failure.

Downloads files from the SSH 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.

Returns True for success, False for failure.

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

Returns None on failure

Uploads a directory tree from the local filesystem to the SSH 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.

Returns True for success, False for failure.

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

Returns None on failure

Uploads the contents of bd to a file on the SSH server.

Returns True for success, False for failure.

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

Returns None on failure

Uploads binary data to a file on the SSH server.

Returns True for success, False for failure.

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

Returns None on failure

Uploads the binary data to a file on the remote SSH server. The binary data is passed in encoded string representation (such as base64, or hex).

Returns True for success, False for failure.

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

Returns None on failure

Uploads a file from the local filesystem to the remote SSH server.

Returns True for success, False for failure.

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

Returns None on failure

Uploads the contents of a string to a file on the remote SSH server.

Returns True for success, False for failure.

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

Returns None on failure

Uses the SSH connection of sshConnection for the SCP transfers. All of the connection and socket related properties, proxy properites, timeout properties, session log, etc. set on the SSH object apply to the SCP methods (because internally it is the SSH object that is used to do the work of the file transfers).

Note: There is no UnlockComponent method in the SCP class because it is the SSH object that must be unlocked. When the SSH object is not unlocked, this method will return False to indicate failure.

Returns True for success, False for failure.