CkSFtpDir C++ Reference Documentation


Represents a remote SFTP directory listing.


int get_NumFilesAndDirs(void);

The number of entries in this directory listing.

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.

bool get_Utf8(void);
void put_Utf8(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.


CkSFtpFile *GetFileObject(int index);

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.

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.

bool LoadTaskResult(CkTask &task);

Introduced in version

Loads the SFTP directory object from a completed asynchronous task.

Returns true for success, false for failure.