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

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

```powerbuilder
oleobject loo_TaskChain
integer li_rc

loo_TaskChain = create oleobject
li_rc = loo_TaskChain.ConnectToNewObject("Chilkat.TaskChain")
if li_rc < 0 then
    destroy loo_TaskChain
    MessageBox("Error","Connecting to COM object failed")
    return
end if

// ... use loo_TaskChain ...

destroy loo_TaskChain
```

PowerBuilder uses the Chilkat ActiveX through an `oleobject`: declare the variable, `create` it, connect it to the Chilkat class with `ConnectToNewObject`, and `destroy` it when finished. A negative return code from `ConnectToNewObject` means the ActiveX is not registered, or the registered ActiveX does not match the bitness (32-bit or 64-bit) of the PowerBuilder target.

Objects returned by methods (such as an `HttpResponse` or `JsonObject`) are also `oleobject` variables and must likewise be destroyed. A method that fails to return an object returns `null`; test with `IsNull()`. In the signatures on this page, the Chilkat class name identifies which object is expected or returned; the PowerBuilder variable type is always `oleobject`.

To bind to a specific major version of Chilkat, append the major version number to the ProgID, such as `ConnectToNewObject("Chilkat.TaskChain.11")` for Chilkat v11.\*.\*.

Members typed `blob` exchange binary data as a Variant byte array. The PowerBuilder examples instead use the `BinData`-based alternatives (methods ending in *Bd*), which keep binary data inside Chilkat objects.

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

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` | `string DebugLogFilePath` | 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` | `blob LastBinaryResult (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` | `string LastErrorHtml (read-only)` | read-only | Provides HTML-formatted information about the last called method or property. |
| `LastErrorText` | `string LastErrorText (read-only)` | read-only | Provides plain text information about the last called method or property. |
| `LastErrorXml` | `string LastErrorXml (read-only)` | read-only | Provides XML-formatted information about the last called method or property. |
| `LastMethodSuccess` | `long LastMethodSuccess` | read/write | Indicates the success or failure of the most recent method call: `1` means success, `0` means failure. |
| `LastStringResult` | `string LastStringResult (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` | `long LastStringResultLen (read-only)` | read-only | The length, in characters, of the string contained in the LastStringResult property. |
| `VerboseLogging` | `long VerboseLogging` | read/write | If set to `1`, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. |
| `Version` | `string Version (read-only)` | read-only | Version of the component/library, such as "10.1.0" |

## Member index

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

## Properties

### TaskChain.Finished

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

```powerbuilder
long Finished (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.Inert

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

```powerbuilder
long Inert (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 · powerbuilder · TaskChain · Live · property · read-only · since 9.5.0.52`

```powerbuilder
long Live (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 · powerbuilder · TaskChain · NumTasks · property · read-only · since 9.5.0.52`

```powerbuilder
long NumTasks (read-only)
```

The number of tasks contained within the task chain.

### TaskChain.Status

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

```powerbuilder
string Status (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 · powerbuilder · TaskChain · StatusInt · property · read-only · since 9.5.0.52`

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

```powerbuilder
long StopOnFailedTask
```

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 · powerbuilder · TaskChain · Append · method · since 9.5.0.52`

```powerbuilder
long Append(ChilkatTask task)
```

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 · powerbuilder · TaskChain · Cancel · method · since 9.5.0.52`

```powerbuilder
long Cancel()
```

Cancels execution of the asynchronous task chain.

Returns 1 for success, 0 for failure.

### TaskChain.GetTask

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

```powerbuilder
ChilkatTask GetTask(long index)
```

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

Returns `null` on failure

### TaskChain.Run

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

```powerbuilder
long Run()
```

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 · powerbuilder · TaskChain · RunSynchronously · method · since 9.5.0.52`

```powerbuilder
long RunSynchronously()
```

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 · powerbuilder · TaskChain · SleepMs · method · since 9.5.0.52`

```powerbuilder
SleepMs(long numMs)
```

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

### TaskChain.Wait

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

```powerbuilder
long Wait(long maxWaitMs)
```

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

This binding has no event callbacks.

## Related classes

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

