DirTree Tcl Reference Documentation

DirTree

Current Version: 9.5.0.73

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

set myDirTree [new CkDirTree]

Properties

BaseDir
string
# ckStr is a CkString
CkDirTree_get_BaseDir $myDirTree $ckStr
set strVal [CkDirTree_get_baseDir $myDirTree]
CkDirTree_put_BaseDir $myDirTree $strVal

Begin iterating from this directory.

top
DebugLogFilePath
string
# ckStr is a CkString
CkDirTree_get_DebugLogFilePath $myDirTree $ckStr
set strVal [CkDirTree_get_debugLogFilePath $myDirTree]
CkDirTree_put_DebugLogFilePath $myDirTree $strVal

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
boolean 1/0
set boolVal [CkDirTree_get_DoneIterating $myDirTree]

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

top
FileSize32
integer
set intVal [CkDirTree_get_FileSize32 $myDirTree]

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

top
FileSize64
(64-bit integer)
set int64Val [CkDirTree_get_FileSize64 $myDirTree]

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

top
FullPath
string
# ckStr is a CkString
CkDirTree_get_FullPath $myDirTree $ckStr
set strVal [CkDirTree_get_fullPath $myDirTree]

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

top
FullUncPath
string
# ckStr is a CkString
CkDirTree_get_FullUncPath $myDirTree $ckStr
set strVal [CkDirTree_get_fullUncPath $myDirTree]

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

top
IsDirectory
boolean 1/0
set boolVal [CkDirTree_get_IsDirectory $myDirTree]

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

top
LastErrorHtml
string
# ckStr is a CkString
CkDirTree_get_LastErrorHtml $myDirTree $ckStr
set strVal [CkDirTree_get_lastErrorHtml $myDirTree]

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
string
# ckStr is a CkString
CkDirTree_get_LastErrorText $myDirTree $ckStr
set strVal [CkDirTree_get_lastErrorText $myDirTree]

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
string
# ckStr is a CkString
CkDirTree_get_LastErrorXml $myDirTree $ckStr
set strVal [CkDirTree_get_lastErrorXml $myDirTree]

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
boolean 1/0
set boolVal [CkDirTree_get_LastMethodSuccess $myDirTree]
CkDirTree_put_LastMethodSuccess $myDirTree $boolVal
Introduced in version 9.5.0.52

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
Recurse
boolean 1/0
set boolVal [CkDirTree_get_Recurse $myDirTree]
CkDirTree_put_Recurse $myDirTree $boolVal

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

top
RelativePath
string
# ckStr is a CkString
CkDirTree_get_RelativePath $myDirTree $ckStr
set strVal [CkDirTree_get_relativePath $myDirTree]

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

top
Utf8
boolean 1/0
set boolVal [CkDirTree_get_Utf8 $myDirTree]
CkDirTree_put_Utf8 $myDirTree $boolVal

When set to 1, all "const char *" arguments are interpreted as utf-8 strings. If set to 0 (the default), then "const char *" arguments are interpreted as ANSI strings. Also, when set to 1, and Chilkat method returning a "const char *" is returning the utf-8 representation. If set to 0, all "const char *" return values are ANSI strings.

top
VerboseLogging
boolean 1/0
set boolVal [CkDirTree_get_VerboseLogging $myDirTree]
CkDirTree_put_VerboseLogging $myDirTree $boolVal

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
string
# ckStr is a CkString
CkDirTree_get_Version $myDirTree $ckStr
set strVal [CkDirTree_get_version $myDirTree]

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

top

Methods

AdvancePosition
set status [CkDirTree_AdvancePosition]

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
set status [CkDirTree_BeginIterate]

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
SaveLastError
# path is a string
set status [CkDirTree_SaveLastError $path]

Saves the last-error information (the contents of LastErrorXml) to an XML formatted file.

Returns 1 for success, 0 for failure.

top