SFtpDir PureBasic Reference Documentation

SFtpDir

Current Version: 9.5.0.75

Represents a remote SFTP directory listing.

Object Creation

obj.i = CkSFtpDir::ckCreate()

; Make sure to dispose of the object when finished like this:
CkSFtpDir::ckDispose(obj);

Properties

LastMethodSuccess
Declare.i ckLastMethodSuccess(obj.i)
Declare setCkLastMethodSuccess(obj.i, value.i)

Indicate whether the last method call succeeded or failed. A value of 1 indicates success, a value of 0 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 = 1 and failure = 0.
  • 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 1. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

top
NumFilesAndDirs
Declare.i ckNumFilesAndDirs(obj.i) ; (read-only)

The number of entries in this directory listing.

top
OriginalPath
Declare.s ckOriginalPath(obj.i) ; (read-only)

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

Methods

GetFilename
Declare.s ckGetFilename(obj.i, index.l)

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

Returns an empty string on failure. Use the LastMethodSuccess property to check for success.

top
GetFileObject
Declare.i ckGetFileObject(obj.i, index.l)

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

Returns 0 on failure

top
LoadTaskResult
Declare.i ckLoadTaskResult(obj.i, task.i)
Introduced in version 9.5.0.52

Loads the SFTP directory object from a completed asynchronous task.

Returns 1 for success, 0 for failure.

top