SFtpDir Xojo Plugin Reference Documentation

SFtpDir

Current Version: 9.5.0.73

Represents a remote SFTP directory listing.

Object Creation

Dim sFtpDir As New Chilkat.SFtpDir

Properties

LastMethodSuccess
LastMethodSuccess As Boolean

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
NumFilesAndDirs As Int32 (read-only)

The number of entries in this directory listing.

top
OriginalPath
OriginalPath As String (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
Function GetFilename(index As Int32) As String

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

Returns Nil on failure

top
GetFileObject
Function GetFileObject(index As Int32) As Chilkat.SFtpFile

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

Returns Nil on failure

top
LoadTaskResult
Function LoadTaskResult(task As Chilkat.Task) As Boolean
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