---
product: Chilkat
product_version: 11.7.0
language: foxpro
language_label: FoxPro
class: TaskChain
license: bundle
deprecated: false
reference_html: https://www.chilkatsoft.com/refdoc/foxpro_TaskChainRef.html
---
# Chilkat TaskChain — FoxPro — v11.7.0

> Chilkat 11.7.0 · language=foxpro · class=TaskChain
> Other versions: replace `11.7.0` in this URL. Other languages: `https://www.chilkatsoft.com/ai-docs/v/11.7.0/<lang>/classes/TaskChain.md`.
> Language-wide rules (install, unlock, error model, strings/bytes): `https://www.chilkatsoft.com/ai-docs/v/11.7.0/foxpro/guide.md`.

## Purpose

**Run multiple asynchronous Chilkat tasks in a defined sequence.**

`Chilkat.TaskChain` manages a sequence of `Chilkat.Task` objects and runs them one after another. It is useful when multiple asynchronous Chilkat operations must execute in a predictable order while still allowing the entire chain to be started, monitored, waited on, canceled, or run synchronously. A task chain can stop when a task fails, or continue depending on the configured behavior.

**Sequential async workflow**

Append multiple `Task` objects and run them in order when one operation must finish before the next begins.

**Chain-level execution**

Start the entire chain, run it synchronously, wait for completion, or cancel the chain as a single coordinated operation.

**Monitor progress and status**

Inspect whether the chain is live, finished, inert, canceled, failed, or still running.

**Access individual tasks**

Retrieve tasks by index after execution to inspect each task's status, success flag, error text, and result.

**Stop-on-failure control**

Use `StopOnFailedTask` to control whether the chain stops at the first failed task or continues to later tasks.

**Diagnostics**

Use task and chain status information together with `LastErrorText` and each task's result details to troubleshoot ordered async workflows.

**Common pattern:** Create the individual async tasks, append them to a `TaskChain` in the required order, set `StopOnFailedTask` as appropriate, run the chain, wait for completion, then inspect each task's success status and result. Use `TaskChain` when operations must run sequentially; use individual `Task` objects when each async operation can be managed on its own.

For an extended overview, see [TaskChain Class Overview](https://www.chilkatsoft.com/taskchain_class_overview.asp).

## Object creation, unlocking and error handling

**Object Creation**

```foxpro
loTaskChain = CreateObject('Chilkat.TaskChain')
```

Visual FoxPro is a 32-bit application and therefore uses the 32-bit Chilkat ActiveX. To bind to a specific major version of Chilkat, append the major version number to the ProgID, such as `CreateObject('Chilkat.TaskChain.11')` for Chilkat v11.\*.\*.

Call `Global.UnlockBundle` once at the start of the program, before using this or any other Chilkat class. Any string unlocks a fully functional 30-day trial; a purchased unlock code is used in production. See `guide.md` for the exact code in FoxPro.

How failure is reported depends on the method's return type and is stated in the note under each method below. In every case the diagnostic text is in the `LastErrorText` property of the object whose method was called.

## Members common to every Chilkat class

Documented once per language in `common-members.md`; listed here so this page is self-contained.

| Property | Signature | Access | Meaning |
|---|---|---|---|
| `DebugLogFilePath` | `DebugLogFilePath As String` | read/write | If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. |
| `LastBinaryResult` | `LastBinaryResult As Variant (read-only)` | read-only | This property is mainly used in SQL Server stored procedures to retrieve binary data from the last method call that returned binary data. |
| `LastErrorHtml` | `LastErrorHtml As String (read-only)` | read-only | Provides HTML-formatted information about the last called method or property. |
| `LastErrorText` | `LastErrorText As String (read-only)` | read-only | Provides plain text information about the last called method or property. |
| `LastErrorXml` | `LastErrorXml As String (read-only)` | read-only | Provides XML-formatted information about the last called method or property. |
| `LastMethodSuccess` | `LastMethodSuccess As Number` | read/write | Indicates the success or failure of the most recent method call: `1` means success, `0` means failure. |
| `LastStringResult` | `LastStringResult As String (read-only)` | read-only | In SQL Server stored procedures, this property holds the string return value of the most recent method call that returns a string. |
| `LastStringResultLen` | `LastStringResultLen As Number (read-only)` | read-only | The length, in characters, of the string contained in the LastStringResult property. |
| `VerboseLogging` | `VerboseLogging As Number` | read/write | If set to `1`, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. |
| `Version` | `Version As String (read-only)` | read-only | Version of the component/library, such as "10.1.0" |

## Member index

| Member | Kind | Signature |
|---|---|---|
| `Finished` | property, read-only | `Finished As Number (read-only)` |
| `HeartbeatMs` | property, read/write | `HeartbeatMs As Number` |
| `Inert` | property, read-only | `Inert As Number (read-only)` |
| `Live` | property, read-only | `Live As Number (read-only)` |
| `NumTasks` | property, read-only | `NumTasks As Number (read-only)` |
| `Status` | property, read-only | `Status As String (read-only)` |
| `StatusInt` | property, read-only | `StatusInt As Number (read-only)` |
| `StopOnFailedTask` | property, read/write | `StopOnFailedTask As Number` |
| `Append` | method | `Append(task As ChilkatTask) As Number` |
| `Cancel` | method | `Cancel() As Number` |
| `GetTask` | method | `GetTask(index As Number) As ChilkatTask` |
| `Run` | method | `Run() As Number` |
| `RunSynchronously` | method | `RunSynchronously() As Number` |
| `SleepMs` | method | `SleepMs(numMs As Number)` |
| `Wait` | method | `Wait(maxWaitMs As Number) As Number` |

## Properties

### TaskChain.Finished

`Chilkat 11.7.0 · foxpro · TaskChain · Finished · property · read-only · since 9.5.0.52`

```foxpro
Finished As Number (read-only)
```

`1` if the task status is `canceled`, `aborted`, or `completed`. A task chain can only reach the `canceled` status if it was activated via the Run method, made it onto the internal thread pool thread's queue, was waiting for a pool thread to become available, and was then canceled prior to the task actually starting.

### TaskChain.HeartbeatMs

`Chilkat 11.7.0 · foxpro · TaskChain · HeartbeatMs · property · read/write · since 9.5.0.52`

```foxpro
HeartbeatMs As Number
```

The number of milliseconds between each AbortCheck event callback. The AbortCheck callback allows an application to abort the Wait method. If HeartbeatMs is 0 (the default), no AbortCheck event callbacks will fire. **Note:** An asynchronous task chain running in a background thread (in one of the thread pool threads) does not fire events. The task chain's event callbacks pertain only to the Wait method.

### TaskChain.Inert

`Chilkat 11.7.0 · foxpro · TaskChain · Inert · property · read-only · since 9.5.0.52`

```foxpro
Inert As Number (read-only)
```

`1` if the task status is `empty` or `loaded`. When a task chain is inert, it has been loaded but is not scheduled to run yet.

### TaskChain.Live

`Chilkat 11.7.0 · foxpro · TaskChain · Live · property · read-only · since 9.5.0.52`

```foxpro
Live As Number (read-only)
```

`1` if the task status is `queued` or `running`. When a task chain is live, it is either already running, or is on the thread pool thread's queue waiting for a thread to become available.

### TaskChain.NumTasks

`Chilkat 11.7.0 · foxpro · TaskChain · NumTasks · property · read-only · since 9.5.0.52`

```foxpro
NumTasks As Number (read-only)
```

The number of tasks contained within the task chain.

### TaskChain.Status

`Chilkat 11.7.0 · foxpro · TaskChain · Status · property · read-only · since 9.5.0.52`

```foxpro
Status As String (read-only)
```

The current status of the task chain. Possible values are:

- `empty` -- No tasks have yet been appended to the task chain.
- `loaded` -- The task chain has been loaded (appended) with one or more task objects.
- `queued` -- The task chain is in the thread pool's queue of tasks awaiting to be run.
- `running` -- The task chain is currently running.
- `canceled` -- The task chain was canceled before it entered the `running` state.
- `aborted` -- The task chain was canceled while it was in the running state.
- `completed` -- The task chain completed.

### TaskChain.StatusInt

`Chilkat 11.7.0 · foxpro · TaskChain · StatusInt · property · read-only · since 9.5.0.52`

```foxpro
StatusInt As Number (read-only)
```

The current status of the task as an integer value. Possible values are:

- **1** -- `empty` -- No tasks have yet been appended to the task chain.
- **2** -- `loaded` -- The task chain has been loaded (appended) with one or more task objects.
- **3** -- `queued` -- The task chain is in the thread pool's queue of tasks awaiting to be run.
- **4** -- `running` -- The task chain is currently running.
- **5** -- `canceled` -- The task chain was canceled before it entered the `running` state.
- **6** -- `aborted` -- The task chain was canceled while it was in the running state.
- **7** -- `completed` -- The task chain completed.

### TaskChain.StopOnFailedTask

`Chilkat 11.7.0 · foxpro · TaskChain · StopOnFailedTask · property · read/write · since 9.5.0.52`

```foxpro
StopOnFailedTask As Number
```

If `1` then stops execution of the task chain if any individual task fails. Task failure is defined by the standard LastMethodSuccess property. If `0`, then all of the tasks in the chain will be run even if some fail. The default value of this property is `1`.

## Methods

### TaskChain.Append

`Chilkat 11.7.0 · foxpro · TaskChain · Append · method · since 9.5.0.52`

```foxpro
Append(task As ChilkatTask) As Number
```

Appends a task to the task chain. Can fail if the task is already part of another chain. (A task can only be part of a single chain.)

Returns 1 for success, 0 for failure.

### TaskChain.Cancel

`Chilkat 11.7.0 · foxpro · TaskChain · Cancel · method · since 9.5.0.52`

```foxpro
Cancel() As Number
```

Cancels execution of the asynchronous task chain.

Returns 1 for success, 0 for failure.

### TaskChain.GetTask

`Chilkat 11.7.0 · foxpro · TaskChain · GetTask · method · since 9.5.0.52`

```foxpro
GetTask(index As Number) As ChilkatTask
```

Returns the Nth task in the chain. The 1st task is at index 0.

Returns `.NULL.` on failure

### TaskChain.Run

`Chilkat 11.7.0 · foxpro · TaskChain · Run · method · since 9.5.0.52`

```foxpro
Run() As Number
```

Queues the task chain to run on the internal Chilkat thread pool. Each task in the chain will run, one after the other.

Returns 1 for success, 0 for failure.

### TaskChain.RunSynchronously

`Chilkat 11.7.0 · foxpro · TaskChain · RunSynchronously · method · since 9.5.0.52`

```foxpro
RunSynchronously() As Number
```

Runs the task chain synchronously. Then this method returns after all the tasks in the chain have been run.

Returns 1 for success, 0 for failure.

### TaskChain.SleepMs

`Chilkat 11.7.0 · foxpro · TaskChain · SleepMs · method · since 9.5.0.52`

```foxpro
SleepMs(numMs As Number)
```

Convenience method to force the calling thread to sleep for a number of milliseconds.

### TaskChain.Wait

`Chilkat 11.7.0 · foxpro · TaskChain · Wait · method · since 9.5.0.52`

```foxpro
Wait(maxWaitMs As Number) As Number
```

Waits for the task chain to complete. Returns when all of the tasks in the chain have completed, or after `maxWaitMs` milliseconds have elapsed. (A `maxWaitMs` value of 0 is to wait indefinitely.) Returns (`0`) if the task chain has not yet been started by calling the Run method, or if the `maxWaitMs` expired. If the task chain completed, was already completed, was canceled, or aborted, then this method returns `1`.

Returns 1 for success, 0 for failure.

## Events and callbacks

A Visual FoxPro application receives Chilkat ActiveX events by defining a class that `IMPLEMENTS` the `_IChilkatEvents` interface, creating an instance of it, and binding that instance to the Chilkat object with `EVENTHANDLER()`. Visual FoxPro requires the class to implement every method of the interface, so the class below includes a `PROCEDURE` for each event; leave the ones you do not need empty. The `TextData` and `BinaryData` events are defunct: they are deprecated and are never called, but their procedures must still exist because the interface declares them.

**Important:** Event callbacks from ***asynchronous method calls*** are generally not possible from the ActiveX. Events fire during synchronous method calls.

```foxpro
taskChainEventHandler = CREATEOBJECT("MyTaskChainEvents")
loTaskChain = CreateObject('Chilkat.TaskChain')
EVENTHANDLER(loTaskChain, taskChainEventHandler)

DEFINE CLASS MyTaskChainEvents AS SESSION OLEPUBLIC
IMPLEMENTS _IChilkatEvents IN "Chilkat.TaskChain"

PROCEDURE _IChilkatEvents_AbortCheck(abort As Number)
? "AbortCheck"
ENDPROC

* The BinaryData event is defunct: it is deprecated and is never called.
* The procedure must exist because the interface declares it, but it can be left empty.
PROCEDURE _IChilkatEvents_BinaryData(data As Variant)
ENDPROC

PROCEDURE _IChilkatEvents_PercentDone(pctDone As Number, abort As Number)
? "PercentDone"
ENDPROC

PROCEDURE _IChilkatEvents_ProgressInfo(name As String, value As String)
? "ProgressInfo"
ENDPROC

PROCEDURE _IChilkatEvents_TaskCompleted(task As Generic)
? "TaskCompleted"
ENDPROC

* The TextData event is defunct: it is deprecated and is never called.
* The procedure must exist because the interface declares it, but it can be left empty.
PROCEDURE _IChilkatEvents_TextData(data As String)
ENDPROC


ENDDEFINE
```

### TaskChain.AbortCheck (event)

`Chilkat 11.7.0 · foxpro · TaskChain · AbortCheck · event`

```foxpro
AbortCheck(abort As Number)
```

Enables a method call to be aborted by triggering the AbortCheck event at intervals defined by the `HeartbeatMs` property. If HeartbeatMs is set to its default value of 0, no events will occur. For instance, set HeartbeatMs to 200 to trigger 5 AbortCheck events per second.

**FoxPro event implementation:**

```foxpro
* Add to the MyTaskChainEvents class shown in the Events overview above.
PROCEDURE _IChilkatEvents_AbortCheck(abort As Number)
    * Set abort to 1 to abort the method in progress.
ENDPROC
```

### TaskChain.PercentDone (event)

`Chilkat 11.7.0 · foxpro · TaskChain · PercentDone · event`

```foxpro
PercentDone(pctDone As Number, abort As Number)
```

This provides the percentage completion for any method involving network communications or time-consuming processing, assuming the progress can be measured as a percentage. This event is triggered only when it's possible and logical to express the operation's progress as a percentage. The `pctDone` argument will range from 1 to 100. For methods that finish quickly, the number of PercentDone callbacks may vary, but the final callback will have `pctDone` equal to 100. For longer operations, callbacks will not exceed one per percentage point (e.g., 1, 2, 3, ..., 98, 99, 100).

The PercentDone callback also acts as an `AbortCheck` event. For fast methods where PercentDone fires, an AbortCheck event may not trigger since the PercentDone callback already provides an opportunity to abort. For longer operations, where time between PercentDone callbacks is extended, AbortCheck callbacks enable more responsive operation termination.

To abort the operation, set the `abort` output argument to `1`. This will cause the method to terminate and return a failure status or corresponding failure value.

**FoxPro event implementation:**

```foxpro
* Add to the MyTaskChainEvents class shown in the Events overview above.
PROCEDURE _IChilkatEvents_PercentDone(pctDone As Number, abort As Number)
    * pctDone ranges from 1 to 100.  Set abort to 1 to abort the method in progress.
ENDPROC
```

### TaskChain.ProgressInfo (event)

`Chilkat 11.7.0 · foxpro · TaskChain · ProgressInfo · event`

```foxpro
ProgressInfo(name As String, value As String)
```

This event callback provides `tag name`/value pairs that detail what occurs during a method call. To discover existing tag names, create code to handle the event, emit the pairs, and review them. Most tag names are self-explanatory.

Note: Some Chilkat methods don't fire any ProgressInfo events.

**FoxPro event implementation:**

```foxpro
* Add to the MyTaskChainEvents class shown in the Events overview above.
PROCEDURE _IChilkatEvents_ProgressInfo(name As String, value As String)
    ? name + ": " + value
ENDPROC
```

### TaskChain.TaskCompleted (event)

`Chilkat 11.7.0 · foxpro · TaskChain · TaskCompleted · event`

```foxpro
TaskCompleted(task As ChilkatTask)
```

Called from the background thread when an asynchronous task completes.

**FoxPro event implementation:**

```foxpro
* Add to the MyTaskChainEvents class shown in the Events overview above.
PROCEDURE _IChilkatEvents_TaskCompleted(task As Generic)
    * task is the Task object that has completed.
ENDPROC
```

## Related classes

[`Task`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/foxpro/classes/Task.md)

