DirTree DataFlex Reference Documentation

DirTree

Current Version: 9.5.0.75

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

// (Dataflex programs use the 32-bit Chilkat ActiveX)
Handle hoDirTree
Get Create(RefClass(cComCkDirTree)) to hoDirTree

Properties

BaseDir
Function ComBaseDir Returns String
Procedure Set ComBaseDir String value

Begin iterating from this directory.

top
DebugLogFilePath
Function ComDebugLogFilePath Returns String
Procedure Set ComDebugLogFilePath String value

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
Function ComDoneIterating Returns Boolean

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

top
FileSize32
Function ComFileSize32 Returns Integer

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

top
FullPath
Function ComFullPath Returns String

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

top
FullUncPath
Function ComFullUncPath Returns String

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

top
IsDirectory
Function ComIsDirectory Returns Boolean

True if the current position is a sub-directory, False if it is a file.

top
LastBinaryResult
Function ComLastBinaryResult Returns Variant
Introduced in version 9.5.0.52

The binary data returned by the last (binary data returning) method called. Only available if Chilkat.Global.KeepBinaryResult is set to True. 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
Function ComLastErrorHtml Returns String

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
Function ComLastErrorText Returns String

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
Function ComLastErrorXml Returns String

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
Function ComLastMethodSuccess Returns Boolean
Procedure Set ComLastMethodSuccess Boolean value
Introduced in version 9.5.0.52

Indicate whether the last method call succeeded or failed. A value of True indicates success, a value of False 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 = True and failure = False.
  • 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 True. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

top
LastStringResult
Function ComLastStringResult Returns String
Introduced in version 9.5.0.52

The string return value of the last (string returning) method called. Only available if Chilkat.Global.KeepStringResult is set to True. 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
Function ComLastStringResultLen Returns Integer
Introduced in version 9.5.0.53

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

top
Recurse
Function ComRecurse Returns Boolean
Procedure Set ComRecurse Boolean value

If True, the iteration will be recursive. If False the iteration is non-recursive. The default value is True.

top
RelativePath
Function ComRelativePath Returns String

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

top
VerboseLogging
Function ComVerboseLogging Returns Boolean
Procedure Set ComVerboseLogging Boolean value

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

top
Version
Function ComVersion Returns String

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

top

Methods

AdvancePosition
Function ComAdvancePosition Returns Boolean

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

Important: If AdvancePosition returns False, 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 True, then the False return value is not an error, but instead indicates that the end has been reached.

Returns True for success, False for failure.

top
BeginIterate
Function ComBeginIterate Returns Boolean

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 False, 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 True, then the False return value is not an error, but instead indicates 0 files/directories.

Returns True for success, False for failure.

top