---
product: Chilkat
product_version: 11.7.0
language: sqlserver
language_label: SQL Server
class: Dns
license: bundle
deprecated: false
reference_html: https://www.chilkatsoft.com/refdoc/sqlserver_DnsRef.html
---
# Chilkat Dns — SQL Server — v11.7.0

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

```sql
DECLARE @hr int
DECLARE @dns int
EXEC @hr = sp_OACreate 'Chilkat.Dns', @dns OUT
IF @hr <> 0
BEGIN
    PRINT 'Failed to create ActiveX component'
    RETURN
END

-- ... use @dns ...

EXEC @hr = sp_OADestroy @dns
```

T-SQL uses the Chilkat ActiveX through the OLE Automation stored procedures. They must be enabled once on the server (`EXEC sp_configure 'Ole Automation Procedures', 1; RECONFIGURE;`), and the Chilkat ActiveX registered must match the bitness of the SQL Server instance (64-bit for a 64-bit SQL Server). To bind to a specific major version of Chilkat, append the major version number to the ProgID, such as `sp_OACreate 'Chilkat.Dns.11'` for Chilkat v11.\*.\*.

`sp_OACreate` returns an object token (an `int`) that is passed as the first argument of every `sp_OAMethod`, `sp_OAGetProperty` and `sp_OASetProperty` call, and released with `sp_OADestroy`. Objects returned by methods (such as an `HttpResponse` or `JsonObject`) are also tokens received through an `int` OUT parameter; they must likewise be destroyed, and the OUT parameter is `NULL` when the method fails to return an object. Objects passed as arguments are passed by their token. When an OLE Automation procedure itself fails (non-zero `@hr`), `sp_OAGetErrorInfo` describes the error.

Data types: strings are `nvarchar(4000)`; integers, booleans (1 or 0) and object tokens are `int`; dates are `datetime`. In the signatures on this page, `@success`, `@iResult`, `@sResult` and the like are the OUT variables receiving a method's return value, `@iValue` / `@sValue` receive or supply a property value, and the remaining `@` variables are the method's arguments in order.

A string returned through an OUT parameter is limited to 4000 characters. For longer values, retrieve the result as a result set into a table variable instead of an OUT parameter, for example `DECLARE @tmp TABLE (outputLine ntext)` followed by `INSERT INTO @tmp EXEC sp_OAGetProperty @dns, 'LastErrorText'`. See [string length limitations for strings returned by sp_OAMethod calls](https://www.chilkatsoft.com/sql_server_nvarchar_max_limitation.asp).

Methods that pass or return raw byte arrays are not shown on this page, because `varbinary(max)` values cannot be exchanged through `sp_OAMethod` (see [varbinary(max) limitation](https://www.chilkatsoft.com/sql_server_varbinary_max_limitation.asp)). Use the `BinData`-based alternatives (methods ending in *Bd*) or the base64 / hex string-encoded variants instead. Binary *properties* (such as `LastBinaryResult`) can be retrieved as a result set into a table variable, as shown in their signatures. Asynchronous (*\*Async*) methods and event callbacks are not available from SQL Server.

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 SQL Server.

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

## Member index

| Member | Kind | Signature |
|---|---|---|
| `MaxWaitMs` | property, read/write | `EXEC sp_OAGetProperty @dns, 'MaxWaitMs', @iValue OUT EXEC sp_OASetProperty @dns, 'MaxWaitMs', @iValue` |
| `NumNameservers` | property, read-only | `EXEC sp_OAGetProperty @dns, 'NumNameservers', @iValue OUT` |
| `TlsPref` | property, read/write | `EXEC sp_OAGetProperty @dns, 'TlsPref', @iValue OUT EXEC sp_OASetProperty @dns, 'TlsPref', @iValue` |
| `UncommonOptions` | property, read/write | `EXEC sp_OAGetProperty @dns, 'UncommonOptions', @sValue OUT EXEC sp_OASetProperty @dns, 'UncommonOptions', @sValue` |
| `AddDefaultNameservers` | method | `EXEC sp_OAMethod @dns, 'AddDefaultNameservers', NULL` |
| `AddNameserver` | method | `EXEC sp_OAMethod @dns, 'AddNameserver', NULL, @ipAddr, @supportsTls` |
| `GetNameserver` | method | `EXEC sp_OAMethod @dns, 'GetNameserver', @sResult OUT, @index` |
| `Query` | method | `EXEC sp_OAMethod @dns, 'Query', @success OUT, @recordType, @domain, @answer` |
| `RemoveAllNameservers` | method | `EXEC sp_OAMethod @dns, 'RemoveAllNameservers', NULL` |
| `RemoveNameserver` | method | `EXEC sp_OAMethod @dns, 'RemoveNameserver', NULL, @ipAddr` |

## Properties

### Dns.MaxWaitMs

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

```sql
EXEC sp_OAGetProperty @dns, 'MaxWaitMs', @iValue OUT
EXEC sp_OASetProperty @dns, 'MaxWaitMs', @iValue
```

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 · sqlserver · Dns · NumNameservers · property · read-only · since 9.5.0.96`

```sql
EXEC sp_OAGetProperty @dns, 'NumNameservers', @iValue OUT
```

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 · sqlserver · Dns · TlsPref · property · read/write · since 9.5.0.96`

```sql
EXEC sp_OAGetProperty @dns, 'TlsPref', @iValue OUT
EXEC sp_OASetProperty @dns, 'TlsPref', @iValue
```

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

### Dns.UncommonOptions

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

```sql
EXEC sp_OAGetProperty @dns, 'UncommonOptions', @sValue OUT
EXEC sp_OASetProperty @dns, 'UncommonOptions', @sValue
```

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 · sqlserver · Dns · AddDefaultNameservers · method · since 9.5.0.96`

```sql
EXEC sp_OAMethod @dns, 'AddDefaultNameservers', NULL
```

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 · sqlserver · Dns · AddNameserver · method · since 9.5.0.96`

```sql
EXEC sp_OAMethod @dns, 'AddNameserver', NULL, @ipAddr, @supportsTls
```

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 · sqlserver · Dns · GetNameserver · method · since 9.5.0.96`

```sql
EXEC sp_OAMethod @dns, 'GetNameserver', @sResult OUT, @index
```

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 `NULL` on failure

### Dns.Query

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

```sql
EXEC sp_OAMethod @dns, 'Query', @success OUT, @recordType, @domain, @answer
```

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.

### Dns.RemoveAllNameservers

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

```sql
EXEC sp_OAMethod @dns, 'RemoveAllNameservers', NULL
```

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 · sqlserver · Dns · RemoveNameserver · method · since 9.5.0.96`

```sql
EXEC sp_OAMethod @dns, 'RemoveNameserver', NULL, @ipAddr
```

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

This binding has no event callbacks.

## Related classes

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

