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

Create/Dispose

HCkDirTree instance = CkDirTree_Create();
// ...
CkDirTree_Dispose(instance);
HCkDirTree CkDirTree_Create(void);

Creates an instance of the HCkDirTree object and returns a handle ("void *" pointer). The handle is passed in the 1st argument for the functions listed on this page.

void CkDirTree_Dispose(HCkDirTree handle);

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. Also, any handle returned by a Chilkat "C" function must also be freed by the application by calling the appropriate Dispose method, such as CkDirTree_Dispose.

Properties

BaseDir
void CkDirTree_getBaseDir(HCkDirTree cHandle, HCkString retval);
void CkDirTree_putBaseDir(HCkDirTree cHandle, const char *newVal);
const char *CkDirTree_baseDir(HCkDirTree cHandle);

Begin iterating from this directory.

top
DebugLogFilePath
void CkDirTree_getDebugLogFilePath(HCkDirTree cHandle, HCkString retval);
void CkDirTree_putDebugLogFilePath(HCkDirTree cHandle, const char *newVal);
const char *CkDirTree_debugLogFilePath(HCkDirTree cHandle);

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
BOOL CkDirTree_getDoneIterating(HCkDirTree cHandle);

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

top
FileSize32
int CkDirTree_getFileSize32(HCkDirTree cHandle);

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

top
FileSize64
__int64 CkDirTree_getFileSize64(HCkDirTree cHandle);

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

top
FullPath
void CkDirTree_getFullPath(HCkDirTree cHandle, HCkString retval);
const char *CkDirTree_fullPath(HCkDirTree cHandle);

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

top
FullUncPath
void CkDirTree_getFullUncPath(HCkDirTree cHandle, HCkString retval);
const char *CkDirTree_fullUncPath(HCkDirTree cHandle);

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

top
IsDirectory
BOOL CkDirTree_getIsDirectory(HCkDirTree cHandle);

TRUE if the current position is a sub-directory, FALSE if it is a file.

top
LastErrorHtml
void CkDirTree_getLastErrorHtml(HCkDirTree cHandle, HCkString retval);
const char *CkDirTree_lastErrorHtml(HCkDirTree cHandle);

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
void CkDirTree_getLastErrorText(HCkDirTree cHandle, HCkString retval);
const char *CkDirTree_lastErrorText(HCkDirTree cHandle);

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
void CkDirTree_getLastErrorXml(HCkDirTree cHandle, HCkString retval);
const char *CkDirTree_lastErrorXml(HCkDirTree cHandle);

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
BOOL CkDirTree_getLastMethodSuccess(HCkDirTree cHandle);
void CkDirTree_putLastMethodSuccess(HCkDirTree cHandle, BOOL newVal);
Introduced in version 9.5.0.52

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.

top
Recurse
BOOL CkDirTree_getRecurse(HCkDirTree cHandle);
void CkDirTree_putRecurse(HCkDirTree cHandle, BOOL newVal);

If TRUE, the iteration will be recursive. If FALSE the iteration is non-recursive. The default value is TRUE.

top
RelativePath
void CkDirTree_getRelativePath(HCkDirTree cHandle, HCkString retval);
const char *CkDirTree_relativePath(HCkDirTree cHandle);

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

top
Utf8
BOOL CkDirTree_getUtf8(HCkDirTree cHandle);
void CkDirTree_putUtf8(HCkDirTree cHandle, BOOL newVal);

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

top
VerboseLogging
BOOL CkDirTree_getVerboseLogging(HCkDirTree cHandle);
void CkDirTree_putVerboseLogging(HCkDirTree cHandle, BOOL newVal);

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.

top
Version
void CkDirTree_getVersion(HCkDirTree cHandle, HCkString retval);
const char *CkDirTree_version(HCkDirTree cHandle);

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

top

Methods

AdvancePosition
BOOL CkDirTree_AdvancePosition(HCkDirTree cHandle);

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.

top
BeginIterate
BOOL CkDirTree_BeginIterate(HCkDirTree cHandle);

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
SaveLastError
BOOL CkDirTree_SaveLastError(HCkDirTree cHandle, const char *path);

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

Returns TRUE for success, FALSE for failure.

top