DirTree Perl Reference Documentation
CkDirTree
Current Version: 10.1.3
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 = chilkat::CkDirTree->new();
Properties
BaseDir
# $ckStr is a CkString
$dirTree->get_BaseDir($ckStr);
$strVal = $dirTree->baseDir();
$dirTree->put_BaseDir($strVal);
DebugLogFilePath
# $ckStr is a CkString
$dirTree->get_DebugLogFilePath($ckStr);
$strVal = $dirTree->debugLogFilePath();
$dirTree->put_DebugLogFilePath($strVal);
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.
DoneIterating
$boolVal = $dirTree->get_DoneIterating();
Set to 1 when the last file or sub-directory has been iterated.
topFileSize32
$intVal = $dirTree->get_FileSize32();
The file size of the current file in the iteration. (0 if it is a directory.)
topFileSize64
$int64Val = $dirTree->get_FileSize64();
The file size as a 64-bit integer of the current file in the iteration. (0 if it is a directory.)
topFileSizeStr
# $ckStr is a CkString
$dirTree->get_FileSizeStr($ckStr);
$strVal = $dirTree->fileSizeStr();
The file size of the current file in the iteration as a decimal string. (0 if it is a directory.)
topFullPath
# $ckStr is a CkString
$dirTree->get_FullPath($ckStr);
$strVal = $dirTree->fullPath();
The absolute directory path of the current file or sub-directory.
topFullUncPath
# $ckStr is a CkString
$dirTree->get_FullUncPath($ckStr);
$strVal = $dirTree->fullUncPath();
The absolute UNC directory path of the current file or sub-directory.
topIsDirectory
$boolVal = $dirTree->get_IsDirectory();
1 if the current position is a sub-directory, 0 if it is a file.
topLastErrorHtml
# $ckStr is a CkString
$dirTree->get_LastErrorHtml($ckStr);
$strVal = $dirTree->lastErrorHtml();
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.
topLastErrorText
# $ckStr is a CkString
$dirTree->get_LastErrorText($ckStr);
$strVal = $dirTree->lastErrorText();
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.
LastErrorXml
# $ckStr is a CkString
$dirTree->get_LastErrorXml($ckStr);
$strVal = $dirTree->lastErrorXml();
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.
topLastMethodSuccess
$boolVal = $dirTree->get_LastMethodSuccess();
$dirTree->put_LastMethodSuccess($boolVal);
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.
topRecurse
$boolVal = $dirTree->get_Recurse();
$dirTree->put_Recurse($boolVal);
If 1, the iteration will be recursive. If 0 the iteration is non-recursive. The default value is 1.
topRelativePath
# $ckStr is a CkString
$dirTree->get_RelativePath($ckStr);
$strVal = $dirTree->relativePath();
The relative directory path of the current file or sub-directory. (Relative to the BaseDir)
topUtf8
$boolVal = $dirTree->get_Utf8();
$dirTree->put_Utf8($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.
topVerboseLogging
$boolVal = $dirTree->get_VerboseLogging();
$dirTree->put_VerboseLogging($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.
topVersion
# $ckStr is a CkString
$dirTree->get_Version($ckStr);
$strVal = $dirTree->version();
Methods
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.
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