Scp Unicode C Reference Documentation
Scp
Current Version: 10.0.0
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
HCkScpW instance = CkScpW_Create(); // ... CkScpW_Dispose(instance);
Creates an instance of the HCkScpW object and returns a handle ("void *" pointer). The handle is passed in the 1st argument for the functions listed on this page.
Objects created by calling CkScpW_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 CkScpW_Dispose.
Callback Functions
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.
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.
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.
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
void CkScpW_putAbortCurrent(HCkScpW cHandle, BOOL newVal);
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.)
topDebugLogFilePath
void CkScpW_putDebugLogFilePath(HCkScpW cHandle, const wchar_t *newVal);
const wchar_t *CkScpW_debugLogFilePath(HCkScpW 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:
- a timeout related property was set to 0 to explicitly indicate that an infinite timeout is desired,
- the hang is actually a hang within an event callback (i.e. it is a hang within the application code), or
- there is an internal problem (bug) in the Chilkat code that causes the hang.
HeartbeatMs
void CkScpW_putHeartbeatMs(HCkScpW 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.
topLastErrorHtml
const wchar_t *CkScpW_lastErrorHtml(HCkScpW 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.
topLastErrorText
const wchar_t *CkScpW_lastErrorText(HCkScpW 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.
LastErrorXml
const wchar_t *CkScpW_lastErrorXml(HCkScpW 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.
topLastMethodSuccess
void CkScpW_putLastMethodSuccess(HCkScpW cHandle, BOOL newVal);
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.
topPercentDoneScale
void CkScpW_putPercentDoneScale(HCkScpW cHandle, int newVal);
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.
topSendEnv
void CkScpW_putSendEnv(HCkScpW cHandle, const wchar_t *newVal);
const wchar_t *CkScpW_sendEnv(HCkScpW cHandle);
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",
...
}
SyncedFiles
void CkScpW_putSyncedFiles(HCkScpW cHandle, const wchar_t *newVal);
const wchar_t *CkScpW_syncedFiles(HCkScpW cHandle);
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).
SyncMustMatch
void CkScpW_putSyncMustMatch(HCkScpW cHandle, const wchar_t *newVal);
const wchar_t *CkScpW_syncMustMatch(HCkScpW cHandle);
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.
SyncMustMatchDir
void CkScpW_putSyncMustMatchDir(HCkScpW cHandle, const wchar_t *newVal);
const wchar_t *CkScpW_syncMustMatchDir(HCkScpW cHandle);
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.
topSyncMustNotMatch
void CkScpW_putSyncMustNotMatch(HCkScpW cHandle, const wchar_t *newVal);
const wchar_t *CkScpW_syncMustNotMatch(HCkScpW cHandle);
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.
SyncMustNotMatchDir
void CkScpW_putSyncMustNotMatchDir(HCkScpW cHandle, const wchar_t *newVal);
const wchar_t *CkScpW_syncMustNotMatchDir(HCkScpW cHandle);
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.
topUncommonOptions
void CkScpW_putUncommonOptions(HCkScpW cHandle, const wchar_t *newVal);
const wchar_t *CkScpW_uncommonOptions(HCkScpW cHandle);
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.
UnixPermOverride
void CkScpW_putUnixPermOverride(HCkScpW cHandle, const wchar_t *newVal);
const wchar_t *CkScpW_unixPermOverride(HCkScpW cHandle);
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).
topVerboseLogging
void CkScpW_putVerboseLogging(HCkScpW 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.
topVersion
const wchar_t *CkScpW_version(HCkScpW cHandle);
Methods
DownloadBd
Downloads a binary file from the SSH server and appends to the contents of bd.
Returns TRUE for success, FALSE for failure.
topDownloadBdAsync (1)
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 NULL on failure
topDownloadBinary
Downloads a binary file from the SSH server and returns the contents.
Returns TRUE for success, FALSE for failure.
topDownloadBinaryAsync (1)
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
topDownloadBinaryEncoded
const wchar_t *CkScpW_downloadBinaryEncoded(HCkScpW cHandle, const wchar_t *remotePath, const wchar_t *encoding);
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.
DownloadBinaryEncodedAsync (1)
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
topDownloadFile
Downloads a file from the remote SSH server to the local filesystem.
Returns TRUE for success, FALSE for failure.
DownloadFileAsync (1)
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
topDownloadString
const wchar_t *CkScpW_downloadString(HCkScpW cHandle, const wchar_t *remotePath, const wchar_t *charset);
Downloads a text file from the SSH server and returns the contents as a string.
Returns TRUE for success, FALSE for failure.
DownloadStringAsync (1)
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
topLoadTaskCaller
SyncTreeDownload
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.
SyncTreeDownloadAsync (1)
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
topSyncTreeUpload
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.
topSyncTreeUploadAsync (1)
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
topUploadBd
Uploads the contents of bd to a file on the SSH server.
Returns TRUE for success, FALSE for failure.
topUploadBdAsync (1)
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 NULL on failure
topUploadBinary
UploadBinaryAsync (1)
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
topUploadBinaryEncoded
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.
UploadBinaryEncodedAsync (1)
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
topUploadFile
Uploads a file from the local filesystem to the remote SSH server.
Returns TRUE for success, FALSE for failure.
UploadFileAsync (1)
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
topUploadString
Uploads the contents of a string to a file on the remote SSH server.
Returns TRUE for success, FALSE for failure.
UploadStringAsync (1)
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
topUseSsh
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.
top