CkSFtpDirW Unicode C++ Reference Documentation

CkSFtpDirW

Represents a remote SFTP directory listing.

Properties

int get_NumFilesAndDirs(void);

The number of entries in this directory listing.

void get_OriginalPath(CkString &str);
const wchar_t *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.

Methods

CkSFtpFileW *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 wchar_t *getFilename(int index);

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

Returns true for success, false for failure.

bool LoadTaskResult(CkTaskW &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.