CkSFtpDir C++ Reference Documentation

CkSFtpDir

Current Version: 9.5.0.75

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

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

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
NumFilesAndDirs
int get_NumFilesAndDirs(void);

The number of entries in this directory listing.

top
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.

top
Utf8
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.

top

Methods

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.

top
GetFileObject
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.

Returns NULL on failure

top
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.

top