DirTree PureBasic Reference Documentation

DirTree

Current Version: 10.1.2

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

obj.i = CkDirTree::ckCreate()

; Make sure to dispose of the object when finished like this:
CkDirTree::ckDispose(obj);

Properties

BaseDir
Declare.s ckBaseDir(obj.i)
Declare setCkBaseDir(obj.i, value.s)

Begin iterating from this directory.

More Information and Examples
Iterate over Files and Directories in Filesystem Directory Tree
top
DebugLogFilePath
Declare.s ckDebugLogFilePath(obj.i)
Declare setCkDebugLogFilePath(obj.i, value.s)

If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. This logging helps identify the context and history of Chilkat calls leading up to any crash or hang, aiding in debugging.

Enabling the VerboseLogging property provides more detailed information. This property is mainly used for debugging rare instances where a Chilkat method call causes a hang or crash, which should generally not happen.

Possible causes of hangs include:

  • A timeout property set to 0, indicating an infinite timeout.
  • A hang occurring within an event callback in the application code.
  • An internal bug in the Chilkat code causing the hang.

More Information and Examples
Example showing how to use DebugLogFilePath.
top
DoneIterating
Declare.i ckDoneIterating(obj.i) ; (read-only)

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

top
FileSize32
Declare.i ckFileSize32(obj.i) ; (read-only)

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

top
FileSize64
Declare.i ckFileSize64(obj.i) ; (read-only)

The file size as a 64-bit integer of the current file in the iteration. (0 if it is a directory.)

top
FileSizeStr
Declare.s ckFileSizeStr(obj.i) ; (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
Declare.s ckFullPath(obj.i) ; (read-only)

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

top
FullUncPath
Declare.s ckFullUncPath(obj.i) ; (read-only)

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

top
IsDirectory
Declare.i ckIsDirectory(obj.i) ; (read-only)

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

top
LastErrorHtml
Declare.s ckLastErrorHtml(obj.i) ; (read-only)

Provides HTML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

top
LastErrorText
Declare.s ckLastErrorText(obj.i) ; (read-only)

Provides plain text information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

More Information and Examples
Concept of LastErrorTextLastErrorText Standard Information
top
LastErrorXml
Declare.s ckLastErrorXml(obj.i) ; (read-only)

Provides XML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

top
LastMethodSuccess
Declare.i ckLastMethodSuccess(obj.i)
Declare setCkLastMethodSuccess(obj.i, value.i)

Indicates the success or failure of the most recent method call: 1 means success, 0 means failure. This property remains unchanged by property setters or getters. This method is present to address challenges in checking for null or Nothing returns in certain programming languages.

top
Recurse
Declare.i ckRecurse(obj.i)
Declare setCkRecurse(obj.i, value.i)

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

top
RelativePath
Declare.s ckRelativePath(obj.i) ; (read-only)

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

top
VerboseLogging
Declare.i ckVerboseLogging(obj.i)
Declare setCkVerboseLogging(obj.i, value.i)

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
Declare.s ckVersion(obj.i) ; (read-only)

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

More Information and Examples
How to get the Chilkat version at runtime.
top

Methods

AdvancePosition
Declare.i ckAdvancePosition(obj.i)

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.

More Information and Examples
Iterate over Files and Directories in Filesystem Directory Tree
top
BeginIterate
Declare.i ckBeginIterate(obj.i)

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