CkScp Perl Reference Documentation

CkScp

Current Version: 9.5.0.75

An API for SCP over SSH. (SCP is the Secure Copy Protocol.) It is for transferring files or directory trees to or from remote servers. SCP is a simpler protocol than SFTP, and thus the functionality is more limited. However, SCP does not require that an SSH server support the SFTP subsystem. In cases where a server does not allow for SFTP, then SCP is a good choice for file transfer.

Object Creation

$obj = chilkat::CkScp->new();

Properties

AbortCurrent
# $boolVal is a boolean
$boolVal = $scp->get_AbortCurrent();
$scp->put_AbortCurrent($boolVal);
Introduced in version 9.5.0.58

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

top
DebugLogFilePath
# $strVal is a string
# $ckStr is a CkString
$scp->get_DebugLogFilePath($ckStr);
$strVal = $scp->debugLogFilePath();
$scp->put_DebugLogFilePath($strVal);

If set to a file path, causes each Chilkat method or property call to automatically append it's LastErrorText to the specified log file. The information is appended such that if a hang or crash occurs, it is possible to see the context in which the problem occurred, as well as a history of all Chilkat calls up to the point of the problem. The VerboseLogging property can be set to provide more detailed information.

This property is typically used for debugging the rare cases where a Chilkat method call hangs or generates an exception that halts program execution (i.e. crashes). A hang or crash should generally never happen. The typical causes of a hang are:

  1. a timeout related property was set to 0 to explicitly indicate that an infinite timeout is desired,
  2. the hang is actually a hang within an event callback (i.e. it is a hang within the application code), or
  3. there is an internal problem (bug) in the Chilkat code that causes the hang.

top
LastErrorHtml
# $strVal is a string
# $ckStr is a CkString
$scp->get_LastErrorHtml($ckStr);
$strVal = $scp->lastErrorHtml();

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
# $strVal is a string
# $ckStr is a CkString
$scp->get_LastErrorText($ckStr);
$strVal = $scp->lastErrorText();

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
# $strVal is a string
# $ckStr is a CkString
$scp->get_LastErrorXml($ckStr);
$strVal = $scp->lastErrorXml();

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
# $boolVal is a boolean
$boolVal = $scp->get_LastMethodSuccess();
$scp->put_LastMethodSuccess($boolVal);
Introduced in version 9.5.0.52

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

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

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

top
SyncedFiles
# $strVal is a string
# $ckStr is a CkString
$scp->get_SyncedFiles($ckStr);
$strVal = $scp->syncedFiles();
$scp->put_SyncedFiles($strVal);
Introduced in version 9.5.0.51

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

More Information and Examples
top
SyncMustMatch
# $strVal is a string
# $ckStr is a CkString
$scp->get_SyncMustMatch($ckStr);
$strVal = $scp->syncMustMatch();
$scp->put_SyncMustMatch($strVal);
Introduced in version 9.5.0.51

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.

top
SyncMustMatchDir
# $strVal is a string
# $ckStr is a CkString
$scp->get_SyncMustMatchDir($ckStr);
$strVal = $scp->syncMustMatchDir();
$scp->put_SyncMustMatchDir($strVal);
Introduced in version 9.5.0.58

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.

top
SyncMustNotMatch
# $strVal is a string
# $ckStr is a CkString
$scp->get_SyncMustNotMatch($ckStr);
$strVal = $scp->syncMustNotMatch();
$scp->put_SyncMustNotMatch($strVal);
Introduced in version 9.5.0.51

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.

More Information and Examples
top
SyncMustNotMatchDir
# $strVal is a string
# $ckStr is a CkString
$scp->get_SyncMustNotMatchDir($ckStr);
$strVal = $scp->syncMustNotMatchDir();
$scp->put_SyncMustNotMatchDir($strVal);
Introduced in version 9.5.0.58

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.

top
Utf8
# $boolVal is a boolean
$boolVal = $scp->get_Utf8();
$scp->put_Utf8($boolVal);

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

top
VerboseLogging
# $boolVal is a boolean
$boolVal = $scp->get_VerboseLogging();
$scp->put_VerboseLogging($boolVal);

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

top
Version
# $strVal is a string
# $ckStr is a CkString
$scp->get_Version($ckStr);
$strVal = $scp->version();

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

top

Methods

DownloadBinary
# $remotePath is a string
# $outBytes is a CkByteData (output)
$status = $scp->DownloadBinary($remotePath, $outData);
Introduced in version 9.5.0.51

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

Returns 1 for success, 0 for failure.

top
DownloadBinaryAsync (1)
# returns a CkTask
# $remotePath is a string
$ret_task = $scp->DownloadBinaryAsync($remotePath);
Introduced in version 9.5.0.51

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

top
DownloadBinaryEncoded
# $remotePath is a string
# $encoding is a string
# $outStr is a CkString (output)
$status = $scp->DownloadBinaryEncoded($remotePath, $encoding, $outStr);
$retStr = $scp->downloadBinaryEncoded($remotePath, $encoding);
Introduced in version 9.5.0.51

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

Returns 1 for success, 0 for failure.

top
DownloadBinaryEncodedAsync (1)
# returns a CkTask
# $remotePath is a string
# $encoding is a string
$ret_task = $scp->DownloadBinaryEncodedAsync($remotePath, $encoding);
Introduced in version 9.5.0.51

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

top
DownloadFile
# $remotePath is a string
# $localPath is a string
$status = $scp->DownloadFile($remotePath, $localPath);
Introduced in version 9.5.0.51

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

Returns 1 for success, 0 for failure.

top
DownloadFileAsync (1)
# returns a CkTask
# $remotePath is a string
# $localPath is a string
$ret_task = $scp->DownloadFileAsync($remotePath, $localPath);
Introduced in version 9.5.0.51

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

Returns null on failure

top
DownloadString
# $remotePath is a string
# $charset is a string
# $outStr is a CkString (output)
$status = $scp->DownloadString($remotePath, $charset, $outStr);
$retStr = $scp->downloadString($remotePath, $charset);
Introduced in version 9.5.0.51

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

Returns 1 for success, 0 for failure.

More Information and Examples
top
DownloadStringAsync (1)
# returns a CkTask
# $remotePath is a string
# $charset is a string
$ret_task = $scp->DownloadStringAsync($remotePath, $charset);
Introduced in version 9.5.0.51

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

top
SaveLastError
# $path is a string
$status = $scp->SaveLastError($path);

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

Returns 1 for success, 0 for failure.

top
SyncTreeDownload
# $remoteRoot is a string
# $localRoot is a string
# $mode is an integer
# $bRecurse is a boolean
$status = $scp->SyncTreeDownload($remoteRoot, $localRoot, $mode, $bRecurse);
Introduced in version 9.5.0.51

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

More Information and Examples
top
SyncTreeDownloadAsync (1)
# returns a CkTask
# $remoteRoot is a string
# $localRoot is a string
# $mode is an integer
# $bRecurse is a boolean
$ret_task = $scp->SyncTreeDownloadAsync($remoteRoot, $localRoot, $mode, $bRecurse);
Introduced in version 9.5.0.51

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

Returns null on failure

top
SyncTreeUpload
# $localBaseDir is a string
# $remoteBaseDir is a string
# $mode is an integer
# $bRecurse is a boolean
$status = $scp->SyncTreeUpload($localBaseDir, $remoteBaseDir, $mode, $bRecurse);
Introduced in version 9.5.0.51

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

top
SyncTreeUploadAsync (1)
# returns a CkTask
# $localBaseDir is a string
# $remoteBaseDir is a string
# $mode is an integer
# $bRecurse is a boolean
$ret_task = $scp->SyncTreeUploadAsync($localBaseDir, $remoteBaseDir, $mode, $bRecurse);
Introduced in version 9.5.0.51

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

Returns null on failure

top
UploadBinary
# $remotePath is a string
# $binData is a CkByteData
$status = $scp->UploadBinary($remotePath, $binData);
Introduced in version 9.5.0.51

Uploads binary data to a file on the SSH server.

Returns 1 for success, 0 for failure.

top
UploadBinaryAsync (1)
# returns a CkTask
# $remotePath is a string
# $binData is a CkByteData
$ret_task = $scp->UploadBinaryAsync($remotePath, $binData);
Introduced in version 9.5.0.51

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

top
UploadBinaryEncoded
# $remotePath is a string
# $encodedData is a string
# $encoding is a string
$status = $scp->UploadBinaryEncoded($remotePath, $encodedData, $encoding);
Introduced in version 9.5.0.51

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

top
UploadBinaryEncodedAsync (1)
# returns a CkTask
# $remotePath is a string
# $encodedData is a string
# $encoding is a string
$ret_task = $scp->UploadBinaryEncodedAsync($remotePath, $encodedData, $encoding);
Introduced in version 9.5.0.51

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

top
UploadFile
# $localPath is a string
# $remotePath is a string
$status = $scp->UploadFile($localPath, $remotePath);
Introduced in version 9.5.0.51

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

Returns 1 for success, 0 for failure.

top
UploadFileAsync (1)
# returns a CkTask
# $localPath is a string
# $remotePath is a string
$ret_task = $scp->UploadFileAsync($localPath, $remotePath);
Introduced in version 9.5.0.51

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

Returns null on failure

top
UploadString
# $remotePath is a string
# $textData is a string
# $charset is a string
$status = $scp->UploadString($remotePath, $textData, $charset);
Introduced in version 9.5.0.51

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

Returns 1 for success, 0 for failure.

More Information and Examples
top
UploadStringAsync (1)
# returns a CkTask
# $remotePath is a string
# $textData is a string
# $charset is a string
$ret_task = $scp->UploadStringAsync($remotePath, $textData, $charset);
Introduced in version 9.5.0.51

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

top
UseSsh
# $sshConnection is a CkSsh
$status = $scp->UseSsh($sshConnection);
Introduced in version 9.5.0.51

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 0 to indicate failure.

Returns 1 for success, 0 for failure.

top