CkSFtpDir C++ Class Reference

CkSFtpDir

Represents a remote SFTP directory listing.

Properties

void LastErrorHtml(CkString &str);

Error information in HTML format for the last method called.

void LastErrorText(CkString &str);

Error information in plain-text format for the last method called.

void LastErrorXml(CkString &str);

Error information in XML format for the last method called.

int get_NumFilesAndDirs(void);

The number of entries in this directory listing.

void get_OriginalPath(CkString &str);

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) const;
void put_Utf8(bool b);

To be documented soon...

Methods

CkSFtpFile * GetFileObject(int index);

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

bool GetFilename(int index, CkString & outStr);

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

Returns true for success, false for failure.

bool SaveLastError(const char * filename);

Saves the last error information to an XML formatted file.

const char * getFilename(int index);

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

Returns a null on failure

const char * lastErrorHtml();

Error information in HTML format for the last method called.

Returns a null on failure

const char * lastErrorText();

Error information in plain-text format for the last method called.

Returns a null on failure

const char * lastErrorXml();

Error information in XML format for the last method called.

Returns a null on failure

const char * originalPath();

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.

Returns a null on failure