DirTree Delphi DLL Reference Documentation

DirTree

Current Version: 10.0.0

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, 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:

a timeout related property was set to 0 to explicitly indicate that an infinite timeout is desired,
the hang is actually a hang within an event callback (i.e. it is a hang within the application code), or
there is an internal problem (bug) in the Chilkat code that causes 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 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.

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

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

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;

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.

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 "9.5.0.94"

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.