Scp ActiveX 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.

Object Creation

(Visual Basic 6.0)
Dim obj As New ChilkatScp

(ASP)
set obj = Server.CreateObject("Chilkat_9_5_0.Scp")

(VBScript)
set obj = CreateObject("Chilkat_9_5_0.Scp")

(Delphi)
obj := TChilkatScp.Create(Self);

(FoxPro)
loObject = CreateObject('Chilkat_9_5_0.Scp')

(PowerBuilder)
lole_object = create oleobject
li_rc = lole_object.ConnectToNewObject("Chilkat_9_5_0.Scp")

(SQL Server)
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.Scp', @obj OUT

(Javascript)
var obj = new ActiveXObject("Chilkat_9_5_0.Scp");

Properties

AbortCurrent As Long

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

DebugLogFilePath As String

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.

HeartbeatMs As Long

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.

LastBinaryResult As Variant (read-only)

Introduced in version 9.5.0.52

The binary data returned by the last (binary data returning) method called. Only available if Chilkat.Global.KeepBinaryResult is set to 1. This provides a means for obtaining large varbinary results in the SQL Server environment (where limitations exist in getting large amounts of data returned by method calls, but where temp tables can be used for binary properties).

LastErrorHtml As String (read-only)

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.

LastErrorText As String (read-only)

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

LastErrorXml As String (read-only)

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.

LastMethodSuccess As Long

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.

LastStringResult As String (read-only)

Introduced in version 9.5.0.52

The string return value of the last (string returning) method called. Only available if Chilkat.Global.KeepStringResult is set to 1. This provides a means for obtaining large string results in the SQL Server environment (where limitations exist in getting long strings returned by method calls, but where temp tables can be used for string properties).

Long Strings Returned by ActiveX Methods in SQL Server

LastStringResultLen As Long (read-only)

Introduced in version 9.5.0.53

The length, in characters, of the string contained in the LastStringResult property.

PercentDoneScale As Long

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.

SyncedFiles As String

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

(Classic ASP) SCP Sync Tree Download

(Visual FoxPro) SCP Sync Tree Download

(PowerBuilder) SCP Sync Tree Download

(SQL Server) SCP Sync Tree Download

(Visual Basic 6.0) SCP Sync Tree Download

(VBScript) SCP Sync Tree Download

(Classic ASP) SCP Sync Tree Upload

(Visual FoxPro) SCP Sync Tree Upload

(PowerBuilder) SCP Sync Tree Upload

(SQL Server) SCP Sync Tree Upload

(Visual Basic 6.0) SCP Sync Tree Upload

(VBScript) SCP Sync Tree Upload

SyncMustMatch As String

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.

(Classic ASP) SCP Sync Tree Download

(Visual FoxPro) SCP Sync Tree Download

(PowerBuilder) SCP Sync Tree Download

(SQL Server) SCP Sync Tree Download

(Visual Basic 6.0) SCP Sync Tree Download

(VBScript) SCP Sync Tree Download

(Classic ASP) SCP Sync Tree Upload

(Visual FoxPro) SCP Sync Tree Upload

(PowerBuilder) SCP Sync Tree Upload

(SQL Server) SCP Sync Tree Upload

(Visual Basic 6.0) SCP Sync Tree Upload

(VBScript) SCP Sync Tree Upload

(Classic ASP) SCP Download Files Matching a Pattern, such as *.txt

(Visual FoxPro) SCP Download Files Matching a Pattern, such as *.txt

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

(SQL Server) SCP Download Files Matching a Pattern, such as *.txt

(Visual Basic 6.0) SCP Download Files Matching a Pattern, such as *.txt

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

SyncMustMatchDir As String

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.

SyncMustNotMatch As String

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.

(Classic ASP) SCP Sync Tree Download

(Visual FoxPro) SCP Sync Tree Download

(PowerBuilder) SCP Sync Tree Download

(SQL Server) SCP Sync Tree Download

(Visual Basic 6.0) SCP Sync Tree Download

(VBScript) SCP Sync Tree Download

(Classic ASP) SCP Sync Tree Upload

(Visual FoxPro) SCP Sync Tree Upload

(PowerBuilder) SCP Sync Tree Upload

(SQL Server) SCP Sync Tree Upload

(Visual Basic 6.0) SCP Sync Tree Upload

(VBScript) SCP Sync Tree Upload

SyncMustNotMatchDir As String

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.

VerboseLogging As Long

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.

Version As String (read-only)

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

Methods

DownloadBinary(remotePath As String) As Variant

Introduced in version 9.5.0.51

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

Returns a zero-length byte array (as a Variant) on failure.
An empty array will have a UBound of -1 meaning 0 elements.

DownloadBinaryAsync(remotePath As String) As ChilkatTask

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

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns Nothing on failure

(Classic ASP) How to Run an Asynchronous Task

(Visual FoxPro) How to Run an Asynchronous Task

(PowerBuilder) How to Run an Asynchronous Task

(SQL Server) How to Run an Asynchronous Task

(Visual Basic 6.0) How to Run an Asynchronous Task

(VBScript) How to Run an Asynchronous Task

Asynchronous Methods in VB6 - Be Very Careful with Callbacks

DownloadBinaryEncoded(remotePath As String, encoding As String) As String

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

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

(Classic ASP) SCP Download/Upload Binary Files as Encoded Strings

(Visual FoxPro) SCP Download/Upload Binary Files as Encoded Strings

(PowerBuilder) SCP Download/Upload Binary Files as Encoded Strings

(SQL Server) SCP Download/Upload Binary Files as Encoded Strings

(Visual Basic 6.0) SCP Download/Upload Binary Files as Encoded Strings

(VBScript) SCP Download/Upload Binary Files as Encoded Strings

DownloadBinaryEncodedAsync(remotePath As String, encoding As String) As ChilkatTask

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

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns Nothing on failure

(Classic ASP) How to Run an Asynchronous Task

(Visual FoxPro) How to Run an Asynchronous Task

(PowerBuilder) How to Run an Asynchronous Task

(SQL Server) How to Run an Asynchronous Task

(Visual Basic 6.0) How to Run an Asynchronous Task

(VBScript) How to Run an Asynchronous Task

Asynchronous Methods in VB6 - Be Very Careful with Callbacks

DownloadFile(remotePath As String, localPath As String) As Long

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.

(Classic ASP) SCP Download File

(Visual FoxPro) SCP Download File

(PowerBuilder) SCP Download File

(SQL Server) SCP Download File

(Visual Basic 6.0) SCP Download File

(VBScript) SCP Download File

(Classic ASP) SCP Download from a Specific Directory

(Visual FoxPro) SCP Download from a Specific Directory

(PowerBuilder) SCP Download from a Specific Directory

(SQL Server) SCP Download from a Specific Directory

(Visual Basic 6.0) SCP Download from a Specific Directory

(VBScript) SCP Download from a Specific Directory

DownloadFileAsync(remotePath As String, localPath As String) As ChilkatTask

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

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns Nothing on failure

(Classic ASP) How to Run an Asynchronous Task

(Visual FoxPro) How to Run an Asynchronous Task

(PowerBuilder) How to Run an Asynchronous Task

(SQL Server) How to Run an Asynchronous Task

(Visual Basic 6.0) How to Run an Asynchronous Task

(VBScript) How to Run an Asynchronous Task

Asynchronous Methods in VB6 - Be Very Careful with Callbacks

DownloadString(remotePath As String, charset As String) As String

Introduced in version 9.5.0.51

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

Returns Nothing on failure

(Classic ASP) SCP Download Text File to String Variable

(Visual FoxPro) SCP Download Text File to String Variable

(PowerBuilder) SCP Download Text File to String Variable

(SQL Server) SCP Download Text File to String Variable

(Visual Basic 6.0) SCP Download Text File to String Variable

(VBScript) SCP Download Text File to String Variable

Long Strings Returned by ActiveX Methods in SQL Server

DownloadStringAsync(remotePath As String, charset As String) As ChilkatTask

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

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns Nothing on failure

(Classic ASP) How to Run an Asynchronous Task

(Visual FoxPro) How to Run an Asynchronous Task

(PowerBuilder) How to Run an Asynchronous Task

(SQL Server) How to Run an Asynchronous Task

(Visual Basic 6.0) How to Run an Asynchronous Task

(VBScript) How to Run an Asynchronous Task

Asynchronous Methods in VB6 - Be Very Careful with Callbacks

SyncTreeDownload(remoteRoot As String, localRoot As String, ByVal mode As Long, ByVal bRecurse As Long) As Long

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.

(Classic ASP) SCP Sync Tree Download

(Visual FoxPro) SCP Sync Tree Download

(PowerBuilder) SCP Sync Tree Download

(SQL Server) SCP Sync Tree Download

(Visual Basic 6.0) SCP Sync Tree Download

(VBScript) SCP Sync Tree Download

SyncTreeDownloadAsync(remoteRoot As String, localRoot As String, ByVal mode As Long, ByVal bRecurse As Long) As ChilkatTask

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

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns Nothing on failure

(Classic ASP) How to Run an Asynchronous Task

(Visual FoxPro) How to Run an Asynchronous Task

(PowerBuilder) How to Run an Asynchronous Task

(SQL Server) How to Run an Asynchronous Task

(Visual Basic 6.0) How to Run an Asynchronous Task

(VBScript) How to Run an Asynchronous Task

Asynchronous Methods in VB6 - Be Very Careful with Callbacks

SyncTreeUpload(localBaseDir As String, remoteBaseDir As String, ByVal mode As Long, ByVal bRecurse As Long) As Long

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.

SyncTreeUploadAsync(localBaseDir As String, remoteBaseDir As String, ByVal mode As Long, ByVal bRecurse As Long) As ChilkatTask

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

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns Nothing on failure

(Classic ASP) How to Run an Asynchronous Task

(Visual FoxPro) How to Run an Asynchronous Task

(PowerBuilder) How to Run an Asynchronous Task

(SQL Server) How to Run an Asynchronous Task

(Visual Basic 6.0) How to Run an Asynchronous Task

(VBScript) How to Run an Asynchronous Task

Asynchronous Methods in VB6 - Be Very Careful with Callbacks

UploadBinary(remotePath As String, binData As Variant) As Long

Introduced in version 9.5.0.51

Uploads binary data to a file on the SSH server.

Returns 1 for success, 0 for failure.

UploadBinaryAsync(remotePath As String, binData As Variant) As ChilkatTask

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

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns Nothing on failure

(Classic ASP) How to Run an Asynchronous Task

(Visual FoxPro) How to Run an Asynchronous Task

(PowerBuilder) How to Run an Asynchronous Task

(SQL Server) How to Run an Asynchronous Task

(Visual Basic 6.0) How to Run an Asynchronous Task

(VBScript) How to Run an Asynchronous Task

Asynchronous Methods in VB6 - Be Very Careful with Callbacks

UploadBinaryEncoded(remotePath As String, encodedData As String, encoding As String) As Long

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.

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

(Classic ASP) SCP Download/Upload Binary Files as Encoded Strings

(Visual FoxPro) SCP Download/Upload Binary Files as Encoded Strings

(PowerBuilder) SCP Download/Upload Binary Files as Encoded Strings

(SQL Server) SCP Download/Upload Binary Files as Encoded Strings

(Visual Basic 6.0) SCP Download/Upload Binary Files as Encoded Strings

(VBScript) SCP Download/Upload Binary Files as Encoded Strings

UploadBinaryEncodedAsync(remotePath As String, encodedData As String, encoding As String) As ChilkatTask

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

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns Nothing on failure

(Classic ASP) How to Run an Asynchronous Task

(Visual FoxPro) How to Run an Asynchronous Task

(PowerBuilder) How to Run an Asynchronous Task

(SQL Server) How to Run an Asynchronous Task

(Visual Basic 6.0) How to Run an Asynchronous Task

(VBScript) How to Run an Asynchronous Task

Asynchronous Methods in VB6 - Be Very Careful with Callbacks

UploadFile(localPath As String, remotePath As String) As Long

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.

(Classic ASP) SCP Upload File

(Visual FoxPro) SCP Upload File

(PowerBuilder) SCP Upload File

(SQL Server) SCP Upload File

(Visual Basic 6.0) SCP Upload File

(VBScript) SCP Upload File

(Classic ASP) SCP Upload to a Specific Remote Directory

(Visual FoxPro) SCP Upload to a Specific Remote Directory

(PowerBuilder) SCP Upload to a Specific Remote Directory

(SQL Server) SCP Upload to a Specific Remote Directory

(Visual Basic 6.0) SCP Upload to a Specific Remote Directory

(VBScript) SCP Upload to a Specific Remote Directory

UploadFileAsync(localPath As String, remotePath As String) As ChilkatTask

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

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns Nothing on failure

(Classic ASP) How to Run an Asynchronous Task

(Visual FoxPro) How to Run an Asynchronous Task

(PowerBuilder) How to Run an Asynchronous Task

(SQL Server) How to Run an Asynchronous Task

(Visual Basic 6.0) How to Run an Asynchronous Task

(VBScript) How to Run an Asynchronous Task

Asynchronous Methods in VB6 - Be Very Careful with Callbacks

UploadString(remotePath As String, textData As String, charset As String) As Long

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.

(Classic ASP) SCP Upload Contents of String to Remote File

(Visual FoxPro) SCP Upload Contents of String to Remote File

(PowerBuilder) SCP Upload Contents of String to Remote File

(SQL Server) SCP Upload Contents of String to Remote File

(Visual Basic 6.0) SCP Upload Contents of String to Remote File

(VBScript) SCP Upload Contents of String to Remote File

UploadStringAsync(remotePath As String, textData As String, charset As String) As ChilkatTask

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

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns Nothing on failure

(Classic ASP) How to Run an Asynchronous Task

(Visual FoxPro) How to Run an Asynchronous Task

(PowerBuilder) How to Run an Asynchronous Task

(SQL Server) How to Run an Asynchronous Task

(Visual Basic 6.0) How to Run an Asynchronous Task

(VBScript) How to Run an Asynchronous Task

Asynchronous Methods in VB6 - Be Very Careful with Callbacks

UseSsh(sshConnection As ChilkatSsh) As Long

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.

Events

AbortCheck(abort As Long)

Provides the opportunity for a method call to be aborted. The AbortCheck event is fired periodically based on the value of the HeartbeatMs property. If HeartbeatMs is 0, then no AbortCheck events will fire. As an example, to fire 5 AbortCheck events per second, set the HeartbeatMs property equal to 200.

VB6 Event callback implementation:

Important: Event callbacks from asynchronous method calls are generally not possible from the ActiveX. See VB6 Async Callbacks

Dim WithEvents myScp As ChilkatScp

Private Sub myScp_AbortCheck(abort As Long)

	'Insert application code here.

End Sub

BinaryData(data As Variant)

Binary data provided by certain methods.

VB6 Event callback implementation:

Important: Event callbacks from asynchronous method calls are generally not possible from the ActiveX. See VB6 Async Callbacks

Dim WithEvents myScp As ChilkatScp

Private Sub myScp_BinaryData(data As Variant)

	'Insert application code here.

End Sub

PercentDone(ByVal pctDone As Long, abort As Long)

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 event is only fired 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 operations (Chilkat method calls) 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).

The PercentDone callback counts as an AbortCheck event. For method calls that complete quickly such that PercentDone events fire, it may be that AbortCheck events don't fire because the opportunity to abort is already provided in the PercentDone callback. For time consuming operations, where the amount of time between PercentDone callbacks are long, AbortCheck callbacks may be used to allow for the operation to be aborted in a more responsive manner.

The abort output argument provides a means for aborting the operation. Setting it to 1 will cause the method to abort and return a failed status (or whatever return value indicates failure).

VB6 Event callback implementation:

Important: Event callbacks from asynchronous method calls are generally not possible from the ActiveX. See VB6 Async Callbacks

Dim WithEvents myScp As ChilkatScp

Private Sub myScp_PercentDone(ByVal pctDone As Long, abort As Long)

	'Insert application code here.

End Sub

ProgressInfo(name As String, value As String)

A general name/value event that provides information about what is happening during a method call. To find out what information is available, write code to handle this event and log the name/value pairs. Most are self-explanatory.

VB6 Event callback implementation:

Important: Event callbacks from asynchronous method calls are generally not possible from the ActiveX. See VB6 Async Callbacks

Dim WithEvents myScp As ChilkatScp

Private Sub myScp_ProgressInfo(name As String, value As String)

	'Insert application code here.

End Sub

TextData(data As String)

Text data provided by certain methods.

VB6 Event callback implementation:

Important: Event callbacks from asynchronous method calls are generally not possible from the ActiveX. See VB6 Async Callbacks

Dim WithEvents myScp As ChilkatScp

Private Sub myScp_TextData(data As String)

	'Insert application code here.

End Sub