DirTree Delphi DLL 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.

Create/Dispose

var
myObject: HCkDirTree;

begin
myObject := CkDirTree_Create();

// ...

CkDirTree_Dispose(myObject);
end;

function CkDirTree_Create: HCkDirTree; stdcall;

Creates an instance of the HCkDirTree object and returns a handle (i.e. a Pointer). The handle is passed in the 1st argument for the functions listed on this page.

procedure CkDirTree_Dispose(handle: HCkDirTree); stdcall;

Objects created by calling CkDirTree_Create must be freed by calling this method. A memory leak occurs if a handle is not disposed by calling this function.

Properties

BaseDir

procedure CkDirTree_getBaseDir(objHandle: HCkDirTree; outPropVal: HCkString); stdcall;
procedure CkDirTree_putBaseDir(objHandle: HCkDirTree; newPropVal: PWideChar); stdcall;
function CkDirTree__baseDir(objHandle: HCkDirTree): PWideChar; stdcall;

Begin iterating from this directory.

See the notes about PWideChar memory ownership and validity.

More Information and Examples

Iterate over Files and Directories in Filesystem Directory Tree

DebugLogFilePath

procedure CkDirTree_getDebugLogFilePath(objHandle: HCkDirTree; outPropVal: HCkString); stdcall;
procedure CkDirTree_putDebugLogFilePath(objHandle: HCkDirTree; newPropVal: PWideChar); stdcall;
function CkDirTree__debugLogFilePath(objHandle: HCkDirTree): PWideChar; stdcall;

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.

See the notes about PWideChar memory ownership and validity.

More Information and Examples

Example showing how to use DebugLogFilePath.

DoneIterating

function CkDirTree_getDoneIterating(objHandle: HCkDirTree): wordbool; stdcall;

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

FileSize32

function CkDirTree_getFileSize32(objHandle: HCkDirTree): Integer; stdcall;

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

FileSize64

function CkDirTree_getFileSize64(objHandle: HCkDirTree): Int64; stdcall;

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

FileSizeStr

procedure CkDirTree_getFileSizeStr(objHandle: HCkDirTree; outPropVal: HCkString); stdcall;
function CkDirTree__fileSizeStr(objHandle: HCkDirTree): PWideChar; stdcall;

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.)

See the notes about PWideChar memory ownership and validity.

FullPath

procedure CkDirTree_getFullPath(objHandle: HCkDirTree; outPropVal: HCkString); stdcall;
function CkDirTree__fullPath(objHandle: HCkDirTree): PWideChar; stdcall;

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

See the notes about PWideChar memory ownership and validity.

FullUncPath

procedure CkDirTree_getFullUncPath(objHandle: HCkDirTree; outPropVal: HCkString); stdcall;
function CkDirTree__fullUncPath(objHandle: HCkDirTree): PWideChar; stdcall;

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

See the notes about PWideChar memory ownership and validity.

IsDirectory

function CkDirTree_getIsDirectory(objHandle: HCkDirTree): wordbool; stdcall;

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

LastErrorHtml

procedure CkDirTree_getLastErrorHtml(objHandle: HCkDirTree; outPropVal: HCkString); stdcall;
function CkDirTree__lastErrorHtml(objHandle: HCkDirTree): PWideChar; stdcall;

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.

See the notes about PWideChar memory ownership and validity.

LastErrorText

procedure CkDirTree_getLastErrorText(objHandle: HCkDirTree; outPropVal: HCkString); stdcall;
function CkDirTree__lastErrorText(objHandle: HCkDirTree): PWideChar; stdcall;

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.

See the notes about PWideChar memory ownership and validity.

More Information and Examples

Concept of LastErrorText LastErrorText Standard Information

LastErrorXml

procedure CkDirTree_getLastErrorXml(objHandle: HCkDirTree; outPropVal: HCkString); stdcall;
function CkDirTree__lastErrorXml(objHandle: HCkDirTree): PWideChar; stdcall;

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.

See the notes about PWideChar memory ownership and validity.

LastMethodSuccess

function CkDirTree_getLastMethodSuccess(objHandle: HCkDirTree): wordbool; stdcall;
procedure CkDirTree_putLastMethodSuccess(objHandle: HCkDirTree; newPropVal: wordbool); stdcall;

Indicates the success or failure of the most recent method call: True means success, False 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.

Recurse

function CkDirTree_getRecurse(objHandle: HCkDirTree): wordbool; stdcall;
procedure CkDirTree_putRecurse(objHandle: HCkDirTree; newPropVal: wordbool); stdcall;

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

RelativePath

procedure CkDirTree_getRelativePath(objHandle: HCkDirTree; outPropVal: HCkString); stdcall;
function CkDirTree__relativePath(objHandle: HCkDirTree): PWideChar; stdcall;

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

See the notes about PWideChar memory ownership and validity.

VerboseLogging

function CkDirTree_getVerboseLogging(objHandle: HCkDirTree): wordbool; stdcall;
procedure CkDirTree_putVerboseLogging(objHandle: HCkDirTree; newPropVal: wordbool); stdcall;

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.

Version

procedure CkDirTree_getVersion(objHandle: HCkDirTree; outPropVal: HCkString); stdcall;
function CkDirTree__version(objHandle: HCkDirTree): PWideChar; stdcall;

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

See the notes about PWideChar memory ownership and validity.

More Information and Examples

How to get the Chilkat version at runtime.

Methods

AdvancePosition

function CkDirTree_AdvancePosition(objHandle: HCkDirTree): wordbool; stdcall;

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.

More Information and Examples

Iterate over Files and Directories in Filesystem Directory Tree

BeginIterate

function CkDirTree_BeginIterate(objHandle: HCkDirTree): wordbool; stdcall;

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.