DirTree ActiveX Reference Documentation

DirTree

Current Version: 9.5.0.97

API for iterating over the files and sub-directories in a directory tree. The intent of this class is to provide a simplified, non-recursive way to iterate over an entire directory tree.

Object Creation

(ASP)
set obj = Server.CreateObject("Chilkat_9_5_0.DirTree")

(AutoIt)
$obj = ObjCreate("Chilkat_9_5_0.DirTree")

(Visual Basic 6.0)
Dim obj As New CkDirTree

(VBScript)
set obj = CreateObject("Chilkat_9_5_0.DirTree")

(Delphi)
obj := TCkDirTree.Create(Self);

(FoxPro)
loObject = CreateObject('Chilkat_9_5_0.DirTree')

(PowerBuilder)
lole_object = create oleobject
li_rc = lole_object.ConnectToNewObject("Chilkat_9_5_0.DirTree")

(SQL Server)
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.DirTree', @obj OUT

(Javascript)
var obj = new ActiveXObject("Chilkat_9_5_0.DirTree");

Properties

BaseDir
BaseDir As String

Begin iterating from this directory.

top
DebugLogFilePath
DebugLogFilePath As String

If set to a file path, causes each Chilkat method or property call to automatically append it's LastErrorText to the specified log file. The information is appended such that if a hang or crash occurs, it is possible to see the context in which the problem occurred, as well as a history of all Chilkat calls up to the point of the problem. The VerboseLogging property can be set to provide more detailed information.

This property is typically used for debugging the rare cases where a Chilkat method call hangs or generates an exception that halts program execution (i.e. crashes). A hang or crash should generally never happen. The typical causes of a hang are:

  1. a timeout related property was set to 0 to explicitly indicate that an infinite timeout is desired,
  2. the hang is actually a hang within an event callback (i.e. it is a hang within the application code), or
  3. there is an internal problem (bug) in the Chilkat code that causes the hang.

top
DoneIterating
DoneIterating As Long (read-only)

Set to 1 when the last file or sub-directory has been iterated.

top
FileSize32
FileSize32 As Long (read-only)

The file size of the current file in the iteration. (0 if it is a directory.)

top
FileSizeStr
FileSizeStr As String (read-only)
Introduced in version 9.5.0.88

The file size of the current file in the iteration as a decimal string. (0 if it is a directory.)

top
FullPath
FullPath As String (read-only)

The absolute directory path of the current file or sub-directory.

top
FullUncPath
FullUncPath As String (read-only)

The absolute UNC directory path of the current file or sub-directory.

top
IsDirectory
IsDirectory As Long (read-only)

1 if the current position is a sub-directory, 0 if it is a file.

top
LastBinaryResult
LastBinaryResult As Variant (read-only)

The binary data returned by the last (binary data returning) method called. Only available if Chilkat.Global.KeepBinaryResult is set to 1. This provides a means for obtaining large varbinary results in the SQL Server environment (where limitations exist in getting large amounts of data returned by method calls, but where temp tables can be used for binary properties).

top
LastErrorHtml
LastErrorHtml As String (read-only)

Provides information in HTML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

top
LastErrorText
LastErrorText As String (read-only)

Provides information in plain-text format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

top
LastErrorXml
LastErrorXml As String (read-only)

Provides information in XML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

top
LastMethodSuccess
LastMethodSuccess As Long

Indicate whether the last method call succeeded or failed. A value of 1 indicates success, a value of 0 indicates failure. This property is automatically set for method calls. It is not modified by property accesses. The property is automatically set to indicate success for the following types of method calls:

  • Any method that returns a string.
  • Any method returning a Chilkat object, binary bytes, or a date/time.
  • Any method returning a standard boolean status value where success = 1 and failure = 0.
  • Any method returning an integer where failure is defined by a return value less than zero.

Note: Methods that do not fit the above requirements will always set this property equal to 1. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

top
LastStringResult
LastStringResult As String (read-only)

The string return value of the last (string returning) method called. Only available if Chilkat.Global.KeepStringResult is set to 1. This provides a means for obtaining large string results in the SQL Server environment (where limitations exist in getting long strings returned by method calls, but where temp tables can be used for string properties).

top
LastStringResultLen
LastStringResultLen As Long (read-only)

The length, in characters, of the string contained in the LastStringResult property.

top
Recurse
Recurse As Long

If 1, the iteration will be recursive. If 0 the iteration is non-recursive. The default value is 1.

top
RelativePath
RelativePath As String (read-only)

The relative directory path of the current file or sub-directory. (Relative to the BaseDir)

top
VerboseLogging
VerboseLogging As Long

If set to 1, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is 0. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.

top
Version
Version As String (read-only)

Version of the component/library, such as "9.5.0.94"

top

Methods

AdvancePosition
AdvancePosition() As Long

Advances the current position in the directory tree traversal to the next file or sub-directory.

Important: If AdvancePosition returns 0, it can be an error, or it could be that there are no more files and directories. To distinguish between the two cases, examine the DoneIterating property. If DoneIterating is 1, then the 0 return value is not an error, but instead indicates that the end has been reached.

Returns 1 for success, 0 for failure.

top
BeginIterate
BeginIterate() As Long

Begins a directory tree traversal. After calling this method, the various property values such as Fullpath, FileSize32, etc. can be retrieved for the 1st file / sub-directory in the traversal.

Important: If BeginIterate returns 0, it can be an error, or it could be that there are 0 files and directories. To distinguish between the two cases, examine the DoneIterating property. If DoneIterating is 1, then the 0 return value is not an error, but instead indicates 0 files/directories.

Returns 1 for success, 0 for failure.

top