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

> Chilkat 11.7.0 · language=xojo · 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/xojo/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**

```xojo
Dim taskChain As New Chilkat.TaskChain
```

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

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. |
| `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 Boolean` | read/write | Indicates the success or failure of the most recent method call: `True` means success, `False` means failure. |
| `VerboseLogging` | `VerboseLogging As Boolean` | read/write | If set to `True`, 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 Boolean (read-only)` |
| `HeartbeatMs` | property, read/write | `HeartbeatMs As Int32` |
| `Inert` | property, read-only | `Inert As Boolean (read-only)` |
| `Live` | property, read-only | `Live As Boolean (read-only)` |
| `NumTasks` | property, read-only | `NumTasks As Int32 (read-only)` |
| `Status` | property, read-only | `Status As String (read-only)` |
| `StatusInt` | property, read-only | `StatusInt As Int32 (read-only)` |
| `StopOnFailedTask` | property, read/write | `StopOnFailedTask As Boolean` |
| `Append` | method | `Function Append(task As Chilkat.Task) As Boolean` |
| `Cancel` | method | `Function Cancel() As Boolean` |
| `GetTask` | method | `Function GetTask(index As Int32) As Chilkat.Task` |
| `Run` | method | `Function Run() As Boolean` |
| `RunSynchronously` | method | `Function RunSynchronously() As Boolean` |
| `SleepMs` | method | `Sub SleepMs(numMs As Int32)` |
| `Wait` | method | `Function Wait(maxWaitMs As Int32) As Boolean` |

## Properties

### TaskChain.Finished

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

```xojo
Finished As Boolean (read-only)
```

`True` 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 · xojo · TaskChain · HeartbeatMs · property · read/write · since 9.5.0.52`

```xojo
HeartbeatMs As Int32
```

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 · xojo · TaskChain · Inert · property · read-only · since 9.5.0.52`

```xojo
Inert As Boolean (read-only)
```

`True` 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 · xojo · TaskChain · Live · property · read-only · since 9.5.0.52`

```xojo
Live As Boolean (read-only)
```

`True` 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 · xojo · TaskChain · NumTasks · property · read-only · since 9.5.0.52`

```xojo
NumTasks As Int32 (read-only)
```

The number of tasks contained within the task chain.

### TaskChain.Status

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

```xojo
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 · xojo · TaskChain · StatusInt · property · read-only · since 9.5.0.52`

```xojo
StatusInt As Int32 (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 · xojo · TaskChain · StopOnFailedTask · property · read/write · since 9.5.0.52`

```xojo
StopOnFailedTask As Boolean
```

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

## Methods

### TaskChain.Append

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

```xojo
Function Append(task As Chilkat.Task) As Boolean
```

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 True for success, False for failure.

### TaskChain.Cancel

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

```xojo
Function Cancel() As Boolean
```

Cancels execution of the asynchronous task chain.

Returns True for success, False for failure.

### TaskChain.GetTask

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

```xojo
Function GetTask(index As Int32) As Chilkat.Task
```

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

Returns `Nil` on failure

### TaskChain.Run

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

```xojo
Function Run() As Boolean
```

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

Returns True for success, False for failure.

### TaskChain.RunSynchronously

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

```xojo
Function RunSynchronously() As Boolean
```

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

Returns True for success, False for failure.

### TaskChain.SleepMs

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

```xojo
Sub SleepMs(numMs As Int32)
```

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

### TaskChain.Wait

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

```xojo
Function Wait(maxWaitMs As Int32) As Boolean
```

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 (`False`) 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 `True`.

Returns True for success, False for failure.

## Events and callbacks

In Xojo, Chilkat events are handled by subclassing. Add a new class to your project that inherits from Chilkat.TaskChain, then override the event methods you want to respond to. Any method you don't override keeps its default do-nothing behavior, so you only need to write the ones you actually care about.

From that point on, create and use an instance of your subclass wherever you would have used a Chilkat.TaskChain. The events fire on your instance automatically as the object does its work.

**For example:**

```vb
class MyTaskChain
    Inherits Chilkat.TaskChain

    Function AbortCheck() As Boolean
    Function PercentDone(pctDone As Int32) As Boolean
    Sub ProgressInfo(name As String, value As String)
    Sub TaskCompleted(task As Chilkat.Task)

End Class
```

### TaskChain.AbortCheck (event)

`Chilkat 11.7.0 · xojo · TaskChain · AbortCheck · event`

```xojo
Function AbortCheck() As Boolean
```

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.

### TaskChain.PercentDone (event)

`Chilkat 11.7.0 · xojo · TaskChain · PercentDone · event`

```xojo
Function PercentDone(pctDone As Int32) As Boolean
```

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 `True`. This will cause the method to terminate and return a failure status or corresponding failure value.

### TaskChain.ProgressInfo (event)

`Chilkat 11.7.0 · xojo · TaskChain · ProgressInfo · event`

```xojo
Sub 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.

### TaskChain.TaskCompleted (event)

`Chilkat 11.7.0 · xojo · TaskChain · TaskCompleted · event`

```xojo
Sub TaskCompleted(task As Chilkat.Task)
```

Called from the background thread when an asynchronous task completes.

## Related classes

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

