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

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

## Purpose

**Iterate through files and subdirectories under a base directory.**

`Chilkat.DirTree` is a lightweight directory-tree iterator for traversing files and subdirectories under a selected base directory. It supports recursive and non-recursive traversal and exposes useful information about the current item, including absolute path, UNC path, relative path, file size, and whether the current item is a directory.

**Directory traversal**

Iterate through the contents of a base directory, either recursively or one level at a time.

**Current-item details**

Get the current item's full path, relative path, UNC path, size, and directory/file status.

**Recursive scanning**

Traverse entire directory trees when an application needs to process all nested files and folders.

**Non-recursive listing**

Limit iteration to the immediate contents of the base directory when deeper traversal is not needed.

**Path-friendly output**

Use absolute or relative paths depending on whether the application needs filesystem access or archive-style relative names.

**Error-aware iteration**

Use `DoneIterating` to distinguish normal completion from an error when an iteration method returns false.

**Common pattern:** Set the base directory and recursion behavior, begin iterating, process each current item using the path and metadata properties, then check `DoneIterating` when iteration stops to determine whether traversal completed normally or ended because of an error.

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

## Object creation, unlocking and error handling

**Object Creation**

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

-- ... use @dirTree ...

EXEC @hr = sp_OADestroy @dirTree
```

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

## Member index

| Member | Kind | Signature |
|---|---|---|
| `BaseDir` | property, read/write | `EXEC sp_OAGetProperty @dirTree, 'BaseDir', @sValue OUT EXEC sp_OASetProperty @dirTree, 'BaseDir', @sValue` |
| `DoneIterating` | property, read-only | `EXEC sp_OAGetProperty @dirTree, 'DoneIterating', @iValue OUT` |
| `FileSize32` | property, read-only | `EXEC sp_OAGetProperty @dirTree, 'FileSize32', @iValue OUT` |
| `FileSizeStr` | property, read-only | `EXEC sp_OAGetProperty @dirTree, 'FileSizeStr', @sValue OUT` |
| `FullPath` | property, read-only | `EXEC sp_OAGetProperty @dirTree, 'FullPath', @sValue OUT` |
| `FullUncPath` | property, read-only | `EXEC sp_OAGetProperty @dirTree, 'FullUncPath', @sValue OUT` |
| `IsDirectory` | property, read-only | `EXEC sp_OAGetProperty @dirTree, 'IsDirectory', @iValue OUT` |
| `Recurse` | property, read/write | `EXEC sp_OAGetProperty @dirTree, 'Recurse', @iValue OUT EXEC sp_OASetProperty @dirTree, 'Recurse', @iValue` |
| `RelativePath` | property, read-only | `EXEC sp_OAGetProperty @dirTree, 'RelativePath', @sValue OUT` |
| `UncommonOptions` | property, read/write | `EXEC sp_OAGetProperty @dirTree, 'UncommonOptions', @sValue OUT EXEC sp_OASetProperty @dirTree, 'UncommonOptions', @sValue` |
| `AdvancePosition` | method | `EXEC sp_OAMethod @dirTree, 'AdvancePosition', @success OUT` |
| `BeginIterate` | method | `EXEC sp_OAMethod @dirTree, 'BeginIterate', @success OUT` |

## Properties

### DirTree.BaseDir

`Chilkat 11.7.0 · sqlserver · DirTree · BaseDir · property · read/write`

```sql
EXEC sp_OAGetProperty @dirTree, 'BaseDir', @sValue OUT
EXEC sp_OASetProperty @dirTree, 'BaseDir', @sValue
```

Specifies the root directory whose contents are traversed. Set this property before calling `BeginIterate`.

The value may be an absolute filesystem path or a relative path. A relative path is resolved from the calling process's current working directory.

**Iteration scope:** The iterator visits the files and subdirectories contained under this directory. The `Recurse` property determines whether nested levels are included.

### DirTree.DoneIterating

`Chilkat 11.7.0 · sqlserver · DirTree · DoneIterating · property · read-only`

```sql
EXEC sp_OAGetProperty @dirTree, 'DoneIterating', @iValue OUT
```

Indicates whether the traversal has reached its normal end and no current item remains.

This property is especially important because both `BeginIterate` and `AdvancePosition` can return *`0`* for either normal completion or an error:

| Method result | `DoneIterating` | Meaning |
| :--- | :--- | :--- |
| `0` | `1` | The directory was empty, or the last item has been passed. This is normal completion. |
| `0` | `0` | An error occurred. Examine `LastErrorText`. |

### DirTree.FileSize32

`Chilkat 11.7.0 · sqlserver · DirTree · FileSize32 · property · read-only`

```sql
EXEC sp_OAGetProperty @dirTree, 'FileSize32', @iValue OUT
```

Returns the size of the current file in bytes as a 32-bit integer. The value is `0` when the current item is a directory.

**Large files:** A 32-bit integer cannot represent all modern file sizes. Use `FileSize64` when the language binding provides it, or `FileSizeStr` when a decimal string is more portable.

### DirTree.FileSizeStr

`Chilkat 11.7.0 · sqlserver · DirTree · FileSizeStr · property · read-only · since 9.5.0.88`

```sql
EXEC sp_OAGetProperty @dirTree, 'FileSizeStr', @sValue OUT
```

Returns the size of the current file in bytes as an unsigned decimal string. The value is `0` when the current item is a directory.

This representation is useful for very large files and for language bindings where a 64-bit integer is unavailable or inconvenient. Convert the string to an appropriate arbitrary-precision or 64-bit numeric type only when arithmetic is required.

### DirTree.FullPath

`Chilkat 11.7.0 · sqlserver · DirTree · FullPath · property · read-only`

```sql
EXEC sp_OAGetProperty @dirTree, 'FullPath', @sValue OUT
```

Returns the absolute filesystem path of the current file or subdirectory, including the item's name.

The path uses the native path syntax for the operating system. For a path relative to `BaseDir`, use `RelativePath`.

### DirTree.FullUncPath

`Chilkat 11.7.0 · sqlserver · DirTree · FullUncPath · property · read-only`

```sql
EXEC sp_OAGetProperty @dirTree, 'FullUncPath', @sValue OUT
```

Returns the current item's Windows extended-length absolute path. For example, a local path may be returned as `\\?\C:\data\reports\file.txt`; a network path may use the `\\?\UNC\server\share\...` form.

**Windows path form:** The `\\?\` prefix asks Windows to use extended-length path parsing and is useful when working with paths that may exceed legacy path-length limits. Use `FullPath` when an ordinary native absolute path is preferred.

### DirTree.IsDirectory

`Chilkat 11.7.0 · sqlserver · DirTree · IsDirectory · property · read-only`

```sql
EXEC sp_OAGetProperty @dirTree, 'IsDirectory', @iValue OUT
```

Returns *`1`* when the current item is a subdirectory and *`0`* when it is a file.

Check this property before using a file-size property. Directory items report a size of `0`.

### DirTree.Recurse

`Chilkat 11.7.0 · sqlserver · DirTree · Recurse · property · read/write`

```sql
EXEC sp_OAGetProperty @dirTree, 'Recurse', @iValue OUT
EXEC sp_OASetProperty @dirTree, 'Recurse', @iValue
```

Controls whether traversal descends into nested subdirectories.

| `1` | Visit files and directories throughout the complete tree rooted at `BaseDir`. |
| :--- | --- |
| `0` | Visit only the immediate contents of `BaseDir`. |

The default value is *`1`*. Set this property before calling `BeginIterate`.

### DirTree.RelativePath

`Chilkat 11.7.0 · sqlserver · DirTree · RelativePath · property · read-only`

```sql
EXEC sp_OAGetProperty @dirTree, 'RelativePath', @sValue OUT
```

Returns the path of the current file or subdirectory relative to `BaseDir`, including the item's name.

For example, if `BaseDir` is `C:\data` and the current item is `C:\data\images\logo.png`, this property returns `images\logo.png` on Windows. Path separators follow the operating system's native convention.

### DirTree.UncommonOptions

`Chilkat 11.7.0 · sqlserver · DirTree · UncommonOptions · property · read/write · since 11.1.0`

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

Provides a comma-separated list of specialized compatibility options. The default is the empty string, and applications should normally leave it unchanged.

| Keyword | Effect |
| :--- | :--- |
| `Q_EncodePaths` | Returns path-valued output properties in Chilkat's Q-encoded representation. Introduced in Chilkat v11.1.0. This changes only the returned string representation; it does not change which filesystem items are traversed. |

## Methods

### DirTree.AdvancePosition

`Chilkat 11.7.0 · sqlserver · DirTree · AdvancePosition · method`

```sql
EXEC sp_OAMethod @dirTree, 'AdvancePosition', @success OUT
```

Advances the traversal from the current item to the next file or subdirectory.

If the method returns *`1`*, the current-item properties—such as `FullPath`, `RelativePath`, `IsDirectory`, and the file-size properties—describe the newly selected item.

| Return value | `DoneIterating` | Meaning |
| :--- | :--- | :--- |
| `1` | `0` | The iterator advanced successfully and a current item is available. |
| `0` | `1` | The last item has been passed; traversal completed normally. |
| `0` | `0` | An error occurred. Examine `LastErrorText`. |

Returns 1 for success, 0 for failure.

### DirTree.BeginIterate

`Chilkat 11.7.0 · sqlserver · DirTree · BeginIterate · method`

```sql
EXEC sp_OAMethod @dirTree, 'BeginIterate', @success OUT
```

Initializes a new traversal using the current `BaseDir` and `Recurse` settings.

If the method returns *`1`*, the iterator is positioned at the first file or subdirectory, and the current-item properties can be read immediately. Continue by processing that item and then calling `AdvancePosition`.

| Return value | `DoneIterating` | Meaning |
| :--- | :--- | :--- |
| `1` | `0` | The first item is available. |
| `0` | `1` | The directory contains no items in the selected traversal scope. This is not an error. |
| `0` | `0` | Initialization failed. Examine `LastErrorText`. |

**Property lifetime:** Treat the current-item properties as valid only while the iterator is positioned on an item—that is, after a successful `BeginIterate` or `AdvancePosition`.

Returns 1 for success, 0 for failure.

