SFtpDir C++ Reference Documentation

CkSFtpDir

Current Version: 11.0.0

Requires Chilkat Bundle License

Represents a remote SFTP directory listing.

Object Creation

// Local variable on the stack
CkSFtpDir obj;

// Dynamically allocate/delete
CkSFtpDir *pObj = new CkSFtpDir();
// ...
delete pObj;

Properties

DebugLogFilePath

void get_DebugLogFilePath(CkString &str);
const char *debugLogFilePath(void);
void put_DebugLogFilePath(const char *ansiOrUtf8Str);

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.

More Information and Examples

Example showing how to use DebugLogFilePath.

LastErrorHtml

void get_LastErrorHtml(CkString &str);
const char *lastErrorHtml(void);

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.

LastErrorText

void get_LastErrorText(CkString &str);
const char *lastErrorText(void);

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.

More Information and Examples

Concept of LastErrorText LastErrorText Standard Information

LastErrorXml

void get_LastErrorXml(CkString &str);
const char *lastErrorXml(void);

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.

LastMethodSuccess

bool get_LastMethodSuccess(void);
void put_LastMethodSuccess(bool newVal);

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.

NumFilesAndDirs

int get_NumFilesAndDirs(void);

The number of entries in this directory listing.

OriginalPath

void get_OriginalPath(CkString &str);
const char *originalPath(void);

The original path used to fetch this directory listing. This is the string that was originally passed to the OpenDir method when the directory was read.

Utf8

bool get_Utf8(void);
void put_Utf8(bool newVal);

When set to true, all const char * arguments and return values are interpreted as UTF-8 strings. When set to false, they are interpreted as ANSI strings.

In Chilkat v11.0.0 and later, the default value is true. Before v11.0.0, it was false.

VerboseLogging

bool get_VerboseLogging(void);
void put_VerboseLogging(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.

Version

void get_Version(CkString &str);
const char *version(void);

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

More Information and Examples

How to get the Chilkat version at runtime.

Methods

FileAt

bool FileAt(int index, CkSFtpFile &fileObj);

Introduced in version 11.0.0

Returns the entry in the directory at the given index. Indexing begins at 0.

Returns true for success, false for failure.

GetFilename

bool GetFilename(int index, CkString &outStr);
const char *getFilename(int index);

Returns the Nth filename in the directory (indexing begins at 0).

Returns true for success, false for failure.

LoadTaskResult

bool LoadTaskResult(CkTask &task);

Introduced in version 9.5.0.52

Loads the SFTP directory object from a completed asynchronous task.

Returns true for success, false for failure.

Sort

void Sort(const char *field, bool ascending);

Introduced in version 9.5.0.79

Sorts the files and sub-directories in ascending or descending order based on the field. Possible values for field are "filename", "filenameNoCase", "lastModifiedTime", "lastAccessTime", "lastCreateTime", or "size". (For case-insensitive filename sorting, use "filenameNoCase".)

Deprecated

GetFileObject

CkSFtpFile *GetFileObject(int index);

This method is deprecated.

Applications should instead call FileAt.

Returns the Nth entry in the directory. Indexing begins at 0.

Note: The application is responsible for deleting (via the C++ delete operator) the object returned by this method.

Returns NULL on failure