DirTree PowerBuilder Reference Documentation
DirTree
Current Version: 11.6.0
Chilkat.DirTree
Iterate through the contents of a base directory, either recursively or
one level at a time.
Get the current item's full path, relative path, UNC path, size, and
directory/file status.
Traverse entire directory trees when an application needs to process all
nested files and folders.
Limit iteration to the immediate contents of the base directory when
deeper traversal is not needed.
Use absolute or relative paths depending on whether the application needs
filesystem access or archive-style relative names.
Use
For an extended overview, see
DirTree Class Overview.
Iterate through files and subdirectories under a base directory.
Chilkat.DirTree is a lightweight directory-tree iterator for
traversing files and subdirectories under a selected base directory. It
supports recursive and non-recursive traversal and exposes useful information
about the current item, including absolute path, UNC path, relative path,
file size, and whether the current item is a directory.
Directory traversal
Current-item details
Recursive scanning
Non-recursive listing
Path-friendly output
Error-aware iteration
DoneIterating to distinguish normal completion from an
error when an iteration method returns false.
DoneIterating when iteration stops to determine whether traversal
completed normally or ended because of an error.
Object Creation
oleobject loo_DirTree
integer li_rc
loo_DirTree = create oleobject
li_rc = loo_DirTree.ConnectToNewObject("Chilkat.DirTree")
if li_rc < 0 then
destroy loo_DirTree
MessageBox("Error","Connecting to COM object failed")
return
end if
// ... use loo_DirTree ...
destroy loo_DirTreePowerBuilder uses the Chilkat ActiveX through an oleobject: declare the variable, create it, connect it to the Chilkat class with ConnectToNewObject, and destroy it when finished. A negative return code from ConnectToNewObject means the ActiveX is not registered, or the registered ActiveX does not match the bitness (32-bit or 64-bit) of the PowerBuilder target.
Objects returned by methods (such as an HttpResponse or JsonObject) are also oleobject variables and must likewise be destroyed. A method that fails to return an object returns null; test with IsNull(). In the signatures on this page, the Chilkat class name identifies which object is expected or returned; the PowerBuilder variable type is always oleobject.
To bind to a specific major version of Chilkat, append the major version number to the ProgID, such as ConnectToNewObject("Chilkat.DirTree.11") for Chilkat v11.*.*.
Members typed blob exchange binary data as a Variant byte array. The PowerBuilder examples instead use the BinData-based alternatives (methods ending in Bd), which keep binary data inside Chilkat objects.
Properties
BaseDir
Specifies the root directory whose contents are traversed. Set this property before calling BeginIterate.
The value may be an absolute filesystem path or a relative path. A relative path is resolved from the calling process's current working directory.
Recurse property determines whether nested levels are included.
DebugLogFilePath
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
Indicates whether the traversal has reached its normal end and no current item remains.
This property is especially important because both BeginIterate and AdvancePosition can return 0 for either normal completion or an error:
| Method result | DoneIterating |
Meaning |
|---|---|---|
0 |
1 |
The directory was empty, or the last item has been passed. This is normal completion. |
0 |
0 |
An error occurred. Examine LastErrorText. |
FileSize32
Returns the size of the current file in bytes as a 32-bit integer. The value is 0 when the current item is a directory.
FileSize64 when the language binding provides it, or FileSizeStr when a decimal string is more portable.
FileSizeStr
Returns the size of the current file in bytes as an unsigned decimal string. The value is 0 when the current item is a directory.
This representation is useful for very large files and for language bindings where a 64-bit integer is unavailable or inconvenient. Convert the string to an appropriate arbitrary-precision or 64-bit numeric type only when arithmetic is required.
topFullPath
Returns the absolute filesystem path of the current file or subdirectory, including the item's name.
The path uses the native path syntax for the operating system. For a path relative to BaseDir, use RelativePath.
FullUncPath
Returns the current item's Windows extended-length absolute path. For example, a local path may be returned as \\?\C:\data\reports\file.txt; a network path may use the \\?\UNC\server\share\... form.
\\?\ prefix asks Windows to use extended-length path parsing and is useful when working with paths that may exceed legacy path-length limits. Use FullPath when an ordinary native absolute path is preferred.
IsDirectory
Returns 1 when the current item is a subdirectory and 0 when it is a file.
Check this property before using a file-size property. Directory items report a size of 0.
LastBinaryResult
This property is mainly used in SQL Server stored procedures to retrieve binary data from the last method call that returned binary data. It is only accessible if Chilkat.Global.KeepBinaryResult is set to 1. This feature allows for the retrieval of large varbinary results in an SQL Server environment, which has restrictions on returning large data via method calls, though temp tables can handle binary properties.
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
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
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
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. Note: This property does not apply to methods that return integer values or to boolean-returning methods where the boolean does not indicate success or failure.
LastStringResult
In SQL Server stored procedures, this property holds the string return value of the most recent method call that returns a string. It is accessible only when Chilkat.Global.KeepStringResult is set to TRUE. SQL Server has limitations on string lengths returned from methods and properties, but temp tables can be used to access large strings.
LastStringResultLen
The length, in characters, of the string contained in the LastStringResult property.
topRecurse
Controls whether traversal descends into nested subdirectories.
1 |
Visit files and directories throughout the complete tree rooted at BaseDir. |
|---|---|
0 |
Visit only the immediate contents of BaseDir. |
The default value is 1. Set this property before calling BeginIterate.
RelativePath
Returns the path of the current file or subdirectory relative to BaseDir, including the item's name.
For example, if BaseDir is C:\data and the current item is C:\data\images\logo.png, this property returns images\logo.png on Windows. Path separators follow the operating system's native convention.
UncommonOptions
Provides a comma-separated list of specialized compatibility options. The default is the empty string, and applications should normally leave it unchanged.
| Keyword | Effect |
|---|---|
Q_EncodePaths |
Returns path-valued output properties in Chilkat's Q-encoded representation. Introduced in Chilkat v11.1.0. This changes only the returned string representation; it does not change which filesystem items are traversed. |
VerboseLogging
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.
Version
Methods
AdvancePosition
Advances the traversal from the current item to the next file or subdirectory.
If the method returns 1, the current-item properties—such as FullPath, RelativePath, IsDirectory, and the file-size properties—describe the newly selected item.
| Return value | DoneIterating |
Meaning |
|---|---|---|
1 |
0 |
The iterator advanced successfully and a current item is available. |
0 |
1 |
The last item has been passed; traversal completed normally. |
0 |
0 |
An error occurred. Examine LastErrorText. |
Returns 1 for success, 0 for failure.
BeginIterate
Initializes a new traversal using the current BaseDir and Recurse settings.
If the method returns 1, the iterator is positioned at the first file or subdirectory, and the current-item properties can be read immediately. Continue by processing that item and then calling AdvancePosition.
| Return value | DoneIterating |
Meaning |
|---|---|---|
1 |
0 |
The first item is available. |
0 |
1 |
The directory contains no items in the selected traversal scope. This is not an error. |
0 |
0 |
Initialization failed. Examine LastErrorText. |
BeginIterate or AdvancePosition.
Returns 1 for success, 0 for failure.
top