SFtpDir ActiveX Reference Documentation

SFtpDir

Represents a remote SFTP directory listing.

Object Creation

(Visual Basic 6.0)
Dim obj As New ChilkatSFtpDir

(ASP)
set obj = Server.CreateObject("Chilkat_9_5_0.SFtpDir")

(VBScript)
set obj = CreateObject("Chilkat_9_5_0.SFtpDir")

(Delphi)
obj := TChilkatSFtpDir.Create(Self);

(FoxPro)
loObject = CreateObject('Chilkat_9_5_0.SFtpDir')

(PowerBuilder)
lole_object = create oleobject
li_rc = lole_object.ConnectToNewObject("Chilkat_9_5_0.SFtpDir")

(SQL Server)
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.SFtpDir', @obj OUT

(Javascript)
var obj = new ActiveXObject("Chilkat_9_5_0.SFtpDir");

Properties

LastMethodSuccess As Long

Introduced in version 9.5.0.52

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.

NumFilesAndDirs As Long (read-only)

The number of entries in this directory listing.

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.

Methods

GetFilename(ByVal index As Long) As String

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

Returns Nothing on failure

GetFileObject(ByVal index As Long) As ChilkatSFtpFile

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

Returns Nothing on failure

LoadTaskResult(task As ChilkatTask) As Long

Introduced in version 9.5.0.52

Loads the SFTP directory object from a completed asynchronous task.

Returns 1 for success, 0 for failure.