---
product: Chilkat
product_version: 11.7.0
language: xojo
language_label: Xojo
document: language guide
---
> Chilkat 11.7.0 · language=xojo · this file: `https://www.chilkatsoft.com/ai-docs/v/11.7.0/xojo/guide.md`
> Class pages: `https://www.chilkatsoft.com/ai-docs/v/11.7.0/xojo/classes/<Class>.md`

# Chilkat for Xojo — language guide — v11.7.0

## 1. Which Chilkat binding this is

This is the **Chilkat Xojo plugin**: one plugin covering Windows, Linux and macOS (including ARM); classes `Chilkat.Http`, `Chilkat.Zip`, …, created with `New Chilkat.Http`; Xojo properties and methods. This is the only Xojo binding.

## 2. Install and requirements

Download the plugin from [https://www.chilkatsoft.com/xojo.asp](https://www.chilkatsoft.com/xojo.asp) and drop it into Xojo's `Plugins` folder.

## 3. Unlocking and object creation

```xojo
// Required once per process, before any other Chilkat object. Any string unlocks a 30-day trial.
Dim glob As New Chilkat.Global
Dim success As Boolean = glob.UnlockBundle("Anything for 30-day trial")
If Not success Then
    MsgBox(glob.LastErrorText)
    Return
End If

Dim http As New Chilkat.Http
```

- Unlocking only sets a flag in memory: no license files, no network call, so the call is repeated each time the program runs. Extra calls are harmless no-ops; the `Global` object can be discarded afterwards.
- If a program forgets to unlock, Chilkat runs in trial mode and stops working when the trial expires — always include the call, and use the purchased unlock code in production.
- `UnlockBundle` unlocks every class; per-class `UnlockComponent` methods exist only in old code.

## 4. Error model

Methods **do not raise exceptions** for Chilkat-level failures. The note under each method on the class page says how it reports failure: a `Boolean` status method returns `False`; a `String`-returning method returns `Nil`; an object-returning method returns `Nil`; for an `Integer` result check `LastMethodSuccess`. `LastErrorText` holds the diagnostic in every case.

Literals in Xojo: true is `True`, false is `False`, null/none is `Nil`.

## 5. Strings, bytes and encodings

- Strings are Xojo `String`; a `charset` argument names the encoding of the *bytes* being produced or read.
- Binary data is `MemoryBlock` in and out; larger or reusable data goes through `Chilkat.BinData` (`Bd` methods) and text through `Chilkat.StringBuilder` (`Sb` methods).
- Methods with `2`/`3` suffixes or `Quick*` prefixes are distinct members, not overloads.

## 6. Object lifetime and threading

Objects are released by Xojo's reference counting.

A Chilkat object may be used from any thread, but **one object must not be used by two threads at the same time**: create one object per thread or protect it with a lock. Objects are independent — there is no shared global state other than the unlock flag and the few `Global` settings.

## 7. Progress callbacks and async

Progress events are supported: see the "Events and callbacks" section of a class page for the event list and how to attach a handler in this binding (AbortCheck, PercentDone, ProgressInfo and TaskCompleted are the standard ones). Every method with an "Async variant" line also has an `XAsync` twin that returns a `Task` immediately; poll `Finished` or use the `TaskCompleted` event, then read the result from the task. No new Async methods are added from 11.7.0 on. In Xojo, subclass the class (e.g. `Chilkat.Http`) and implement its event handlers; see the "Events and callbacks" section of a class page.

## 8. Common mistakes an AI makes with this binding

1. Writing `CkHttp` or `CreateObject` code — in Xojo it is `New Chilkat.Http`.
2. Omitting `Global.UnlockBundle` (the program runs in trial mode and stops working after 30 days).
3. Inventing members by analogy with other libraries. If a member is not on the class page, it does not exist — look it up rather than guessing.
4. Using deprecated members that older examples still show. The class page lists each one with its replacement; `deprecated.md` lists them all.
5. Ignoring the failure path. Every Chilkat method reports failure (see each method's note); `LastErrorText` says why, and printing it is the first debugging step.
6. Using one Chilkat object from two threads at the same time. Create one object per thread, or protect it with a lock.

## 9. Instructions block for coding agents

Paste into `CLAUDE.md`, `.cursor/rules`, or Copilot instructions:

```
This project uses Chilkat 11.7.0 from Xojo (the Chilkat Xojo plugin; classes Chilkat.Http etc.).
- Reference: https://www.chilkatsoft.com/ai-docs/v/11.7.0/xojo/ — read guide.md once, then classes/<Class>.md for each class used.
- Call UnlockBundle on a New Chilkat.Global once at startup.
- Methods never raise: check the False/Nil result and show LastErrorText.
- Never use a member that is not on the class page; never use members listed as deprecated.
```

## 10. Classes

[Class index for Xojo](https://www.chilkatsoft.com/ai-docs/v/11.7.0/xojo/index.md)