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

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

## Purpose

**Parse a URL into its host, path, query, credentials, port, fragment, and TLS details.**

`Chilkat.Url` is a focused URL parsing class. Given a full URL, it extracts the hostname, host type, login, password, path, query string, fragment, port, and SSL/TLS status into easy-to-read properties. It is useful when application code needs to inspect, validate, route, log, or pass URL parts to lower-level networking or API code.

**Parse full URLs**

Call `ParseUrl` to break a complete URL into structured properties that can be inspected individually.

**Host and host type**

Read the hostname and determine whether it is a DNS name, IPv4 address, or IPv6 address.

**Path and query**

Access the URL path, query string, and combined path-with-query value for request construction or routing.

**Login and password**

Extract embedded userinfo credentials when a URL contains a login and password component.

**Port and TLS status**

Determine the explicit or implied port and whether the URL represents an SSL/TLS connection.

**Fragment handling**

Read the URL fragment separately from the path and query for workflows that need anchor or client-side state information.

**Common pattern:** Use `Url` when the application needs to decompose a URL before making a request or applying custom logic. Parse the full URL, read the properties needed by the caller, then pass the relevant pieces to classes such as `Chilkat.Http`, `Chilkat.Rest`, or `Chilkat.Socket`. Use `Url` for parsing; use the higher-level networking classes to actually send the request.

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

## Object creation, unlocking and error handling

**Object Creation**

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

-- ... use @url ...

EXEC @hr = sp_OADestroy @url
```

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.Url.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 @url, '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 @url, 'DebugLogFilePath', @sValue OUT EXEC sp_OASetProperty @url, '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 @url, '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 @url, 'LastErrorHtml', @sValue OUT` | read-only | Provides HTML-formatted information about the last called method or property. |
| `LastErrorText` | `EXEC sp_OAGetProperty @url, 'LastErrorText', @sValue OUT` | read-only | Provides plain text information about the last called method or property. |
| `LastErrorXml` | `EXEC sp_OAGetProperty @url, 'LastErrorXml', @sValue OUT` | read-only | Provides XML-formatted information about the last called method or property. |
| `LastMethodSuccess` | `EXEC sp_OAGetProperty @url, 'LastMethodSuccess', @iValue OUT EXEC sp_OASetProperty @url, '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 @url, '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 @url, 'LastStringResultLen', @iValue OUT` | read-only | The length, in characters, of the string contained in the LastStringResult property. |
| `VerboseLogging` | `EXEC sp_OAGetProperty @url, 'VerboseLogging', @iValue OUT EXEC sp_OASetProperty @url, '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 @url, 'Version', @sValue OUT` | read-only | Version of the component/library, such as "10.1.0" |

## Member index

| Member | Kind | Signature |
|---|---|---|
| `Frag` | property, read-only | `EXEC sp_OAGetProperty @url, 'Frag', @sValue OUT` |
| `Host` | property, read-only | `EXEC sp_OAGetProperty @url, 'Host', @sValue OUT` |
| `HostType` | property, read-only | `EXEC sp_OAGetProperty @url, 'HostType', @sValue OUT` |
| `Login` | property, read-only | `EXEC sp_OAGetProperty @url, 'Login', @sValue OUT` |
| `Password` | property, read-only | `EXEC sp_OAGetProperty @url, 'Password', @sValue OUT` |
| `Path` | property, read-only | `EXEC sp_OAGetProperty @url, 'Path', @sValue OUT` |
| `PathWithQueryParams` | property, read-only | `EXEC sp_OAGetProperty @url, 'PathWithQueryParams', @sValue OUT` |
| `Port` | property, read-only | `EXEC sp_OAGetProperty @url, 'Port', @iValue OUT` |
| `Query` | property, read-only | `EXEC sp_OAGetProperty @url, 'Query', @sValue OUT` |
| `Scheme` | property, read-only | `EXEC sp_OAGetProperty @url, 'Scheme', @sValue OUT` |
| `Ssl` | property, read-only | `EXEC sp_OAGetProperty @url, 'Ssl', @iValue OUT` |
| `ParseUrl` | method | `EXEC sp_OAMethod @url, 'ParseUrl', @success OUT, @url` |

## Properties

### Url.Frag

`Chilkat 11.7.0 · sqlserver · Url · Frag · property · read-only · since 9.5.0.49`

```sql
EXEC sp_OAGetProperty @url, 'Frag', @sValue OUT
```

Contains any text following a fragment marker (#) in the URL, excluding the fragment marker. Given the URI http://www.contoso.com/index.htm#main, the fragment is `main`.

### Url.Host

`Chilkat 11.7.0 · sqlserver · Url · Host · property · read-only · since 9.5.0.49`

```sql
EXEC sp_OAGetProperty @url, 'Host', @sValue OUT
```

The DNS host name or IP address part of the URL. For example, if the URL is `http://www.contoso.com:8080/`, the Host is `www.contoso.com`. If the URL is `https://192.168.1.124/test.html`, the Host is `192.168.1.124`.

### Url.HostType

`Chilkat 11.7.0 · sqlserver · Url · HostType · property · read-only · since 9.5.0.49`

```sql
EXEC sp_OAGetProperty @url, 'HostType', @sValue OUT
```

The type of the host name specified in the URL. Possible values are:

- `dns`: The host name is a domain name system (DNS) style host name.
- `ipv4`: The host name is an Internet Protocol (IP) version 4 host address.
- `ipv6`: The host name is an Internet Protocol (IP) version 6 host address.

### Url.Login

`Chilkat 11.7.0 · sqlserver · Url · Login · property · read-only · since 9.5.0.49`

```sql
EXEC sp_OAGetProperty @url, 'Login', @sValue OUT
```

If the URL contains a login and password, this is the login part. For example, if the URL is `http://user:password@www.contoso.com/index.htm`, then the login is `user`.

### Url.Password

`Chilkat 11.7.0 · sqlserver · Url · Password · property · read-only · since 9.5.0.49`

```sql
EXEC sp_OAGetProperty @url, 'Password', @sValue OUT
```

If the URL contains a login and password, this is the password part. For example, if the URL is `http://user:password@www.contoso.com/index.htm`, then the password is `password`.

### Url.Path

`Chilkat 11.7.0 · sqlserver · Url · Path · property · read-only · since 9.5.0.49`

```sql
EXEC sp_OAGetProperty @url, 'Path', @sValue OUT
```

The path (and params) part of the URL, excluding the query and fragment. If the URL is: `http://www.amazon.com/gp/product/1476752842/ref=s9_psimh_gw_p14_d0_i3?pf_rd_m=ATVPDKIKX0DER&pf_rd_s=desktop-1`, then the path is `/gp/product/1476752842/ref=s9_psimh_gw_p14_d0_i3`.

### Url.PathWithQueryParams

`Chilkat 11.7.0 · sqlserver · Url · PathWithQueryParams · property · read-only · since 9.5.0.58`

```sql
EXEC sp_OAGetProperty @url, 'PathWithQueryParams', @sValue OUT
```

The path (and params) part of the URL, including the query params, but excluding the fragment. If the URL is: `http://www.amazon.com/gp/product/1476752842/ref=s9_psimh_gw_p14_d0_i3?pf_rd_m=ATVPDKIKX0DER&pf_rd_s=desktop-1`, then then this property returns `/gp/product/1476752842/ref=s9_psimh_gw_p14_d0_i3?pf_rd_m=ATVPDKIKX0DER&pf_rd_s=desktop-1`.

### Url.Port

`Chilkat 11.7.0 · sqlserver · Url · Port · property · read-only · since 9.5.0.49`

```sql
EXEC sp_OAGetProperty @url, 'Port', @iValue OUT
```

The port number of the URL.

For example, if the URL is `http://www.contoso.com:8080/`, the port number is 8080.  
If the URL is `https://192.168.1.124/test.html`, the port number is the default 80.  
If the URL is `https://www.amazon.com/`, the port number is the default SSL/TLS port 443.

### Url.Query

`Chilkat 11.7.0 · sqlserver · Url · Query · property · read-only · since 9.5.0.49`

```sql
EXEC sp_OAGetProperty @url, 'Query', @sValue OUT
```

The query part of the URL, excluding the fragment. If the URL is: `http://www.amazon.com/gp/product/1476752842/ref=s9_psimh_gw_p14_d0_i3?pf_rd_m=ATVPDKIKX0DER&pf_rd_s=desktop-1#frag`, then the query is `pf_rd_m=ATVPDKIKX0DER&pf_rd_s=desktop-1`.

### Url.Scheme

`Chilkat 11.7.0 · sqlserver · Url · Scheme · property · read-only · since 11.6.0`

```sql
EXEC sp_OAGetProperty @url, 'Scheme', @sValue OUT
```

The scheme part of the URL. For example, if the URL is `https://www.contoso.com:8080/`, the Scheme is `https`.

### Url.Ssl

`Chilkat 11.7.0 · sqlserver · Url · Ssl · property · read-only · since 9.5.0.49`

```sql
EXEC sp_OAGetProperty @url, 'Ssl', @iValue OUT
```

`1` if the URL indicates SSL/TLS, otherwise false. A URL beginning with `https://` indicates SSL/TLS.

## Methods

### Url.ParseUrl

`Chilkat 11.7.0 · sqlserver · Url · ParseUrl · method · since 9.5.0.49`

```sql
EXEC sp_OAMethod @url, 'ParseUrl', @success OUT, @url
```

Parses a full URL. After parsing, the various parts of the URL are available iin the properties.

Returns 1 for success, 0 for failure.

