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

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

## Purpose

**Configure DNS resolution and query DNS records directly from Chilkat.**

`Chilkat.Dns` is a focused class for DNS configuration and DNS record querying. It allows applications to control the nameservers used by Chilkat, query common DNS record types into JSON, configure DNS-over-TLS preference, set DNS query timeouts, and obtain useful diagnostics through `LastErrorText`.

**DNS record queries**

Query common DNS record types and receive structured JSON results that are easy to inspect or pass to other application logic.

**Nameserver control**

Configure the nameservers Chilkat uses instead of relying only on the operating system's default DNS configuration.

**DNS-over-TLS preference**

Prefer DNS-over-TLS when appropriate for applications that need encrypted DNS lookups.

**Timeout settings**

Control how long DNS queries may wait before failing, which is useful for responsive applications and troubleshooting.

**Application-wide behavior**

Nameserver settings affect DNS resolution across Chilkat classes, not only the current `Dns` object.

**Diagnostics**

Use `LastErrorText` to troubleshoot DNS configuration, lookup failures, timeout problems, or nameserver connectivity issues.

**Common pattern:** Use `Dns` either to perform direct DNS lookups, or to configure the DNS behavior used by Chilkat as a whole. Because nameserver changes can affect DNS resolution across Chilkat classes, treat them as application-wide configuration rather than object-local state.

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

## Object creation, unlocking and error handling

**Object Creation**

```xojo
Dim dns As New Chilkat.Dns
```

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 |
|---|---|---|
| `HeartbeatMs` | property, read/write | `HeartbeatMs As Int32` |
| `MaxWaitMs` | property, read/write | `MaxWaitMs As Int32` |
| `NumNameservers` | property, read-only | `NumNameservers As Int32 (read-only)` |
| `TlsPref` | property, read/write | `TlsPref As Int32` |
| `UncommonOptions` | property, read/write | `UncommonOptions As String` |
| `AddDefaultNameservers` | method | `Sub AddDefaultNameservers()` |
| `AddNameserver` | method | `Sub AddNameserver(ipAddr As String, supportsTls As Boolean)` |
| `GetNameserver` | method | `Function GetNameserver(index As Int32) As String` |
| `Query` | method | `Function Query(recordType As String, domain As String, answer As Chilkat.JsonObject) As Boolean` |
| `RemoveAllNameservers` | method | `Sub RemoveAllNameservers()` |
| `RemoveNameserver` | method | `Sub RemoveNameserver(ipAddr As String)` |

## Properties

### Dns.HeartbeatMs

`Chilkat 11.7.0 · xojo · Dns · HeartbeatMs · property · read/write · since 9.5.0.96`

```xojo
HeartbeatMs As Int32
```

**Full documentation for this property (same in every language):** [Event Callback Examples](https://www.chilkatsoft.com/ai-docs/v/11.7.0/articles/event_callback_examples.md)

The interval in milliseconds between each `AbortCheck` event callback, which enables an application to abort certain method calls before they complete. **By default, HeartbeatMs is set to** `0`**, meaning no AbortCheck event callbacks will trigger.**

### Dns.MaxWaitMs

`Chilkat 11.7.0 · xojo · Dns · MaxWaitMs · property · read/write · since 9.5.0.96`

```xojo
MaxWaitMs As Int32
```

The maxiumum number of milliseconds to wait for the answer to a DNS query. A value of 0 is to wait indefinitely (no timeout). It's not a good idea to specify 0 (infinite timeout) or a value less than 1000 (1 second). The default value is 10000 milliseconds.

### Dns.NumNameservers

`Chilkat 11.7.0 · xojo · Dns · NumNameservers · property · read-only · since 9.5.0.96`

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

The number of nameservers currently being used by Chilkat for DNS queries in all objects/classes, such as for HTTP, Email, FTP, SSH, etc.

### Dns.TlsPref

`Chilkat 11.7.0 · xojo · Dns · TlsPref · property · read/write · since 9.5.0.96`

```xojo
TlsPref As Int32
```

Specifies the TLS preference. Possible values are:

- 0 = No TLS
- 1 = Prefer TLS if possible.
- 2 = Require TLS

The default value is 0. If TLS is preferred then DNS nameservers with TLS capability will be tried first. If none succeed, then UDP/TCP will be tried. If TLS is required, then only TLS capable nameservers will be tried and all DNS queries will use TLS.

Note: To use TLS, your application needs to first specify nameservers by calling AddNameserver once per nameserver with the supportsTls argument set to `True`.

### Dns.UncommonOptions

`Chilkat 11.7.0 · xojo · Dns · UncommonOptions · property · read/write · since 11.4.0`

```xojo
UncommonOptions As String
```

This is a catch-all property to be used for uncommon needs. This property defaults to the empty string and should typically remain empty.

## Methods

### Dns.AddDefaultNameservers

`Chilkat 11.7.0 · xojo · Dns · AddDefaultNameservers · method · since 9.5.0.96`

```xojo
Sub AddDefaultNameservers()
```

Adds the default (auto-assigned) nameservers to the collection of nameservers used by Chilkat for DNS queries and domain to IP address lookups.

### Dns.AddNameserver

`Chilkat 11.7.0 · xojo · Dns · AddNameserver · method · since 9.5.0.96`

```xojo
Sub AddNameserver(ipAddr As String, supportsTls As Boolean)
```

Adds a new nameserver to the collection of nameservers used by Chilkat for DNS queries and domain to IP address lookups. The `ipAddr` specifies the IPv4 address of the nameserver. The `supportsTls` indicates if the namserver supports DoT (DNS over TLS. DoT uses port 853 for encrypted DNS communication.) If the TlsPreference property is set to 1 or 2, then Chilkat will use TLS nameservers.

### Dns.GetNameserver

`Chilkat 11.7.0 · xojo · Dns · GetNameserver · method · since 9.5.0.96`

```xojo
Function GetNameserver(index As Int32) As String
```

Returns the IP address of the Nth nameserver currently used by Chilkat for DNS queries and domain to IP address lookups. The `index` specifies the index of the nameserver. The 1st nameserver is at `index` 0.

Returns `Nil` on failure

### Dns.Query

`Chilkat 11.7.0 · xojo · Dns · Query · method · since 9.5.0.96`

```xojo
Function Query(recordType As String, domain As String, answer As Chilkat.JsonObject) As Boolean
```

Performs an DNS query for `domain` and returns the answer in `answer`. The type of DNS query is specified in `recordType` and can be A, AAAA, ALIAS, CAA, MX, NS, SOA, TXT. Additional record types can be added as needed.

Async variant: `QueryAsync` — same arguments, returns a `Task` (see Async variants below).

### Dns.RemoveAllNameservers

`Chilkat 11.7.0 · xojo · Dns · RemoveAllNameservers · method · since 9.5.0.96`

```xojo
Sub RemoveAllNameservers()
```

Removes all nameservers from the collection of nameservers used by Chilkat. An application can call this method to reset to 0 nameservers before adding new nameservers. If a DNS domain to IP address resolution is needed by Chilkat, then the auto-assigned nameserver IP addresses will be automaticaly restored.

### Dns.RemoveNameserver

`Chilkat 11.7.0 · xojo · Dns · RemoveNameserver · method · since 9.5.0.96`

```xojo
Sub RemoveNameserver(ipAddr As String)
```

Removes a nameserver from the collection of nameservers used by Chilkat. The `ipAddr` is the IPv4 address of the nameserver to be removed.

## Events and callbacks

In Xojo, Chilkat events are handled by subclassing. Add a new class to your project that inherits from Chilkat.Dns, 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.Dns. The events fire on your instance automatically as the object does its work.

**For example:**

```vb
class MyDns
    Inherits Chilkat.Dns

    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
```

### Dns.AbortCheck (event)

`Chilkat 11.7.0 · xojo · Dns · 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.

### Dns.PercentDone (event)

`Chilkat 11.7.0 · xojo · Dns · 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.

### Dns.ProgressInfo (event)

`Chilkat 11.7.0 · xojo · Dns · 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.

### Dns.TaskCompleted (event)

`Chilkat 11.7.0 · xojo · Dns · TaskCompleted · event`

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

Called from the background thread when an asynchronous task completes.

## Async variants

Each returns a `Task` instead of the result and takes the same arguments as the synchronous method; run the task, wait for `Finished`, then read the result from the task. No new Async methods are added from 11.7.0 on.

```xojo
Function QueryAsync(recordType As String, domain As String, answer As Chilkat.JsonObject) As Chilkat.Task
```

## Related classes

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

