Scp C Reference Documentation

Scp

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.

Create/Dispose

HCkScp CkScp_Create(void);

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

void CkScp_Dispose(HCkScp handle);

Objects created by calling CkScp_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 CkScp_Dispose.

Callback Functions

Callback Functions are Introduced in Chilkat v9.5.0.56

void CkScp_setAbortCheck(HCkHttp cHandle, BOOL (*fnAbortCheck)());

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.

C Example using Callback Functions

void CkScp_setPercentDone(HCkHttp 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 CkScp_setProgressInfo(HCkHttp 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 CkScp_setTaskCompleted(HCkHttp 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

BOOL CkScp_getAbortCurrent(HCkScp cHandle);

void CkScp_putAbortCurrent(HCkScp 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.)

void CkScp_getDebugLogFilePath(HCkScp cHandle, HCkString retval);

void CkScp_putDebugLogFilePath(HCkScp cHandle, const char *newVal);

const char *CkScp_debugLogFilePath(HCkScp 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.

int CkScp_getHeartbeatMs(HCkScp cHandle);

void CkScp_putHeartbeatMs(HCkScp cHandle, int newVal);

This is the number of milliseconds between each AbortCheck event callback. The AbortCheck callback allows an application to abort any SSH operation prior to completion. If HeartbeatMs is 0 (the default), no AbortCheck event callbacks will fire.

void CkScp_getLastErrorHtml(HCkScp cHandle, HCkString retval);

const char *CkScp_lastErrorHtml(HCkScp 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.

void CkScp_getLastErrorText(HCkScp cHandle, HCkString retval);

const char *CkScp_lastErrorText(HCkScp 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.

Concept of LastErrorText

LastErrorText Standard Information

void CkScp_getLastErrorXml(HCkScp cHandle, HCkString retval);

const char *CkScp_lastErrorXml(HCkScp 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.

BOOL CkScp_getLastMethodSuccess(HCkScp cHandle);

void CkScp_putLastMethodSuccess(HCkScp 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.

int CkScp_getPercentDoneScale(HCkScp cHandle);

void CkScp_putPercentDoneScale(HCkScp cHandle, int newVal);

Introduced in version 9.5.0.51

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.

void CkScp_getSyncedFiles(HCkScp cHandle, HCkString retval);

void CkScp_putSyncedFiles(HCkScp cHandle, const char *newVal);

const char *CkScp_syncedFiles(HCkScp cHandle);

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

SCP Sync Tree Download

SCP Sync Tree Upload

void CkScp_getSyncMustMatch(HCkScp cHandle, HCkString retval);

void CkScp_putSyncMustMatch(HCkScp cHandle, const char *newVal);

const char *CkScp_syncMustMatch(HCkScp cHandle);

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.

SCP Sync Tree Download

SCP Sync Tree Upload

SCP Download Files Matching a Pattern, such as *.txt

void CkScp_getSyncMustMatchDir(HCkScp cHandle, HCkString retval);

void CkScp_putSyncMustMatchDir(HCkScp cHandle, const char *newVal);

const char *CkScp_syncMustMatchDir(HCkScp cHandle);

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.

void CkScp_getSyncMustNotMatch(HCkScp cHandle, HCkString retval);

void CkScp_putSyncMustNotMatch(HCkScp cHandle, const char *newVal);

const char *CkScp_syncMustNotMatch(HCkScp cHandle);

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.

SCP Sync Tree Download

SCP Sync Tree Upload

void CkScp_getSyncMustNotMatchDir(HCkScp cHandle, HCkString retval);

void CkScp_putSyncMustNotMatchDir(HCkScp cHandle, const char *newVal);

const char *CkScp_syncMustNotMatchDir(HCkScp cHandle);

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.

BOOL CkScp_getUtf8(HCkScp cHandle);

void CkScp_putUtf8(HCkScp 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.

BOOL CkScp_getVerboseLogging(HCkScp cHandle);

void CkScp_putVerboseLogging(HCkScp 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.

void CkScp_getVersion(HCkScp cHandle, HCkString retval);

const char *CkScp_version(HCkScp cHandle);

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

Methods

BOOL CkScp_DownloadBinary(HCkScp cHandle, const char *remotePath, HCkByteData outBytes);

Introduced in version 9.5.0.51

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

Returns TRUE for success, FALSE for failure.

HCkTask CkScp_DownloadBinaryAsync(HCkScp cHandle, const char *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

How to Run an Asynchronous Task

BOOL CkScp_DownloadBinaryEncoded(HCkScp cHandle, const char *remotePath, const char *encoding, HCkString outStr);

const char *CkScp_downloadBinaryEncoded(HCkScp cHandle, const char *remotePath, const char *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 TRUE for success, FALSE for failure.

List of Supported Encodings (Base64, Hex, etc.)

SCP Download/Upload Binary Files as Encoded Strings

HCkTask CkScp_DownloadBinaryEncodedAsync(HCkScp cHandle, const char *remotePath, const char *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

How to Run an Asynchronous Task

BOOL CkScp_DownloadFile(HCkScp cHandle, const char *remotePath, const char *localPath);

Introduced in version 9.5.0.51

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

Returns TRUE for success, FALSE for failure.

SCP Download File

SCP Download from a Specific Directory

HCkTask CkScp_DownloadFileAsync(HCkScp cHandle, const char *remotePath, const char *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

How to Run an Asynchronous Task

BOOL CkScp_DownloadString(HCkScp cHandle, const char *remotePath, const char *charset, HCkString outStr);

const char *CkScp_downloadString(HCkScp cHandle, const char *remotePath, const char *charset);

Introduced in version 9.5.0.51

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

Returns TRUE for success, FALSE for failure.

SCP Download Text File to String Variable

HCkTask CkScp_DownloadStringAsync(HCkScp cHandle, const char *remotePath, const char *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

How to Run an Asynchronous Task

BOOL CkScp_SaveLastError(HCkScp 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.

BOOL CkScp_SyncTreeDownload(HCkScp cHandle, const char *remoteRoot, const char *localRoot, int mode, BOOL 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 TRUE for success, FALSE for failure.

SCP Sync Tree Download

HCkTask CkScp_SyncTreeDownloadAsync(HCkScp cHandle, const char *remoteRoot, const char *localRoot, int mode, BOOL 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

How to Run an Asynchronous Task

BOOL CkScp_SyncTreeUpload(HCkScp cHandle, const char *localBaseDir, const char *remoteBaseDir, int mode, BOOL 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 TRUE for success, FALSE for failure.

HCkTask CkScp_SyncTreeUploadAsync(HCkScp cHandle, const char *localBaseDir, const char *remoteBaseDir, int mode, BOOL 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

How to Run an Asynchronous Task

BOOL CkScp_UploadBinary(HCkScp cHandle, const char *remotePath, HCkByteData binData);

Introduced in version 9.5.0.51

Uploads binary data to a file on the SSH server.

Returns TRUE for success, FALSE for failure.

HCkTask CkScp_UploadBinaryAsync(HCkScp cHandle, const char *remotePath, HCkByteData 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

How to Run an Asynchronous Task

BOOL CkScp_UploadBinaryEncoded(HCkScp cHandle, const char *remotePath, const char *encodedData, const char *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 TRUE for success, FALSE for failure.

List of Supported Encodings (Base64, Hex, etc.)

SCP Download/Upload Binary Files as Encoded Strings

HCkTask CkScp_UploadBinaryEncodedAsync(HCkScp cHandle, const char *remotePath, const char *encodedData, const char *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

How to Run an Asynchronous Task

BOOL CkScp_UploadFile(HCkScp cHandle, const char *localPath, const char *remotePath);

Introduced in version 9.5.0.51

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

Returns TRUE for success, FALSE for failure.

SCP Upload File

SCP Upload to a Specific Remote Directory

HCkTask CkScp_UploadFileAsync(HCkScp cHandle, const char *localPath, const char *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

How to Run an Asynchronous Task

BOOL CkScp_UploadString(HCkScp cHandle, const char *remotePath, const char *textData, const char *charset);

Introduced in version 9.5.0.51

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

Returns TRUE for success, FALSE for failure.

SCP Upload Contents of String to Remote File

HCkTask CkScp_UploadStringAsync(HCkScp cHandle, const char *remotePath, const char *textData, const char *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

How to Run an Asynchronous Task

BOOL CkScp_UseSsh(HCkScp cHandle, HCkSsh 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 FALSE to indicate failure.

Returns TRUE for success, FALSE for failure.