DirTree Node.js 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
var obj = new chilkat.DirTree();
Properties
BaseDir
· string
DebugLogFilePath
· string
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
· boolean, read-only
Set to true when the last file or sub-directory has been iterated.
topFileSize32
· integer, read-only
The file size of the current file in the iteration. (0 if it is a directory.)
topFileSize64
· 64-bit integer, read-only
The file size as a 64-bit integer of the current file in the iteration. (0 if it is a directory.)
topFileSizeStr
· string, read-only
The file size of the current file in the iteration as a decimal string. (0 if it is a directory.)
topFullPath
· string, read-only
The absolute directory path of the current file or sub-directory.
topFullUncPath
· string, read-only
The absolute UNC directory path of the current file or sub-directory.
topIsDirectory
· boolean, read-only
true if the current position is a sub-directory, false if it is a file.
topLastErrorHtml
· string, 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.
topLastErrorText
· string, 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.
LastErrorXml
· string, 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.
topLastMethodSuccess
· boolean
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.
topRecurse
· boolean
If true, the iteration will be recursive. If false the iteration is non-recursive. The default value is true.
topRelativePath
· string, read-only
The relative directory path of the current file or sub-directory. (Relative to the BaseDir)
topVerboseLogging
· boolean
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.
topVersion
· string, read-only
Methods
AdvancePosition
· Returns Boolean (true for success, false for failure).
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.
BeginIterate
· Returns Boolean (true for success, false for failure).
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.
top